303 lines
12 KiB
Markdown
303 lines
12 KiB
Markdown
# 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\InlineResponse2013 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\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)
|
||
|
||
# **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\InlineResponse2002 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\InlineResponse2002**](../Model/InlineResponse2002.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)
|
||
|