Skip to content

Commit 3625604

Browse files
shubhamUpadhyayInBlueshubhamUpadhyayInBlue
committed
add new changes
1 parent b2876a4 commit 3625604

File tree

404 files changed

+9590
-3886
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404 files changed

+9590
-3886
lines changed

‎README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,12 @@ Class | Method | HTTP request | Description
165165
*SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
166166
*SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
167167
*SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
168-
*SMTPApi* | [**createSmtpTemplate**](docs/Api/SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an smtp template
168+
*SMTPApi* | [**createSmtpTemplate**](docs/Api/SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create a transactional email template
169169
*SMTPApi* | [**deleteHardbounces**](docs/Api/SMTPApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
170-
*SMTPApi* | [**deleteSmtpTemplate**](docs/Api/SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
171-
*SMTPApi* | [**getAggregatedSmtpReport**](docs/Api/SMTPApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
172-
*SMTPApi* | [**getEmailEventReport**](docs/Api/SMTPApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
173-
*SMTPApi* | [**getSmtpReport**](docs/Api/SMTPApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
170+
*SMTPApi* | [**deleteSmtpTemplate**](docs/Api/SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template
171+
*SMTPApi* | [**getAggregatedSmtpReport**](docs/Api/SMTPApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
172+
*SMTPApi* | [**getEmailEventReport**](docs/Api/SMTPApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
173+
*SMTPApi* | [**getSmtpReport**](docs/Api/SMTPApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
174174
*SMTPApi* | [**getSmtpTemplate**](docs/Api/SMTPApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template informations
175175
*SMTPApi* | [**getSmtpTemplates**](docs/Api/SMTPApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of transactional email templates
176176
*SMTPApi* | [**getTransacBlockedContacts**](docs/Api/SMTPApi.md#gettransacblockedcontacts) | **GET** /smtp/blockedContacts | Get the list of blocked or unsubscribed transactional contacts
@@ -291,6 +291,7 @@ Class | Method | HTTP request | Description
291291
- [GetSendersList](docs/Model/GetSendersList.md)
292292
- [GetSendersListIps](docs/Model/GetSendersListIps.md)
293293
- [GetSendersListSenders](docs/Model/GetSendersListSenders.md)
294+
- [GetSharedTemplateUrl](docs/Model/GetSharedTemplateUrl.md)
294295
- [GetSmsCampaignOverview](docs/Model/GetSmsCampaignOverview.md)
295296
- [GetSmsCampaignStats](docs/Model/GetSmsCampaignStats.md)
296297
- [GetSmsCampaigns](docs/Model/GetSmsCampaigns.md)
@@ -305,8 +306,12 @@ Class | Method | HTTP request | Description
305306
- [GetStatsByDomain](docs/Model/GetStatsByDomain.md)
306307
- [GetTransacAggregatedSmsReport](docs/Model/GetTransacAggregatedSmsReport.md)
307308
- [GetTransacBlockedContacts](docs/Model/GetTransacBlockedContacts.md)
309+
- [GetTransacBlockedContactsContacts](docs/Model/GetTransacBlockedContactsContacts.md)
310+
- [GetTransacBlockedContactsReason](docs/Model/GetTransacBlockedContactsReason.md)
308311
- [GetTransacEmailContent](docs/Model/GetTransacEmailContent.md)
312+
- [GetTransacEmailContentEvents](docs/Model/GetTransacEmailContentEvents.md)
309313
- [GetTransacEmailsList](docs/Model/GetTransacEmailsList.md)
314+
- [GetTransacEmailsListTransactionalEmails](docs/Model/GetTransacEmailsListTransactionalEmails.md)
310315
- [GetTransacSmsReport](docs/Model/GetTransacSmsReport.md)
311316
- [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md)
312317
- [GetWebhook](docs/Model/GetWebhook.md)
@@ -322,6 +327,7 @@ Class | Method | HTTP request | Description
322327
- [RemoveContactFromList](docs/Model/RemoveContactFromList.md)
323328
- [RemoveCredits](docs/Model/RemoveCredits.md)
324329
- [RequestContactExport](docs/Model/RequestContactExport.md)
330+
- [RequestContactExportCustomContactFilter](docs/Model/RequestContactExportCustomContactFilter.md)
325331
- [RequestContactImport](docs/Model/RequestContactImport.md)
326332
- [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md)
327333
- [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md)

‎docs/Api/EmailCampaignsApi.md‎

Lines changed: 122 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ Method | HTTP request | Description
77
[**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign
88
[**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign
99
[**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign
10+
[**getAbTestCampaignResult**](EmailCampaignsApi.md#getAbTestCampaignResult) | **GET** /emailCampaigns/{campaignId}/abTestCampaignResult | Get A/B test email campaign result
1011
[**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations
1112
[**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created campaigns
12-
[**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign id of the campaign immediately
13+
[**getSharedTemplateUrl**](EmailCampaignsApi.md#getSharedTemplateUrl) | **GET** /emailCampaigns/{campaignId}/sharedUrl | Get a shared template url
14+
[**sendEmailCampaignNow**](EmailCampaignsApi.md#sendEmailCampaignNow) | **POST** /emailCampaigns/{campaignId}/sendNow | Send an email campaign immediately, based on campaignId
1315
[**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns
1416
[**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list
1517
[**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status
@@ -188,6 +190,65 @@ Name | Type | Description | Notes
188190

189191
[[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)
190192

193+
# **getAbTestCampaignResult**
194+
> \SendinBlue\Client\Model\AbTestCampaignResult getAbTestCampaignResult($campaignId)
195+
196+
Get A/B test email campaign result
197+
198+
Obtain winning version of an A/B test email campaign
199+
200+
### Example
201+
```php
202+
<?php
203+
require_once(__DIR__ . '/vendor/autoload.php');
204+
205+
// Configure API key authorization: api-key
206+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
207+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
208+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
209+
// Configure API key authorization: partner-key
210+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
211+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
212+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
213+
214+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
215+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
216+
// This is optional, `GuzzleHttp\Client` will be used as default.
217+
new GuzzleHttp\Client(),
218+
$config
219+
);
220+
$campaignId = 789; // int | Id of the A/B test campaign
221+
222+
try {
223+
$result = $apiInstance->getAbTestCampaignResult($campaignId);
224+
print_r($result);
225+
} catch (Exception $e) {
226+
echo 'Exception when calling EmailCampaignsApi->getAbTestCampaignResult: ', $e->getMessage(), PHP_EOL;
227+
}
228+
?>
229+
```
230+
231+
### Parameters
232+
233+
Name | Type | Description | Notes
234+
------------- | ------------- | ------------- | -------------
235+
**campaignId** | **int**| Id of the A/B test campaign |
236+
237+
### Return type
238+
239+
[**\SendinBlue\Client\Model\AbTestCampaignResult**](../Model/AbTestCampaignResult.md)
240+
241+
### Authorization
242+
243+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
244+
245+
### HTTP request headers
246+
247+
- **Content-Type**: application/json
248+
- **Accept**: application/json
249+
250+
[[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)
251+
191252
# **getEmailCampaign**
192253
> \SendinBlue\Client\Model\GetEmailCampaign getEmailCampaign($campaignId)
193254
@@ -312,10 +373,69 @@ Name | Type | Description | Notes
312373

313374
[[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)
314375

376+
# **getSharedTemplateUrl**
377+
> \SendinBlue\Client\Model\GetSharedTemplateUrl getSharedTemplateUrl($campaignId)
378+
379+
Get a shared template url
380+
381+
Get a unique URL to share & import an email template from one Sendinblue account to another.
382+
383+
### Example
384+
```php
385+
<?php
386+
require_once(__DIR__ . '/vendor/autoload.php');
387+
388+
// Configure API key authorization: api-key
389+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
390+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
391+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
392+
// Configure API key authorization: partner-key
393+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
394+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
395+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
396+
397+
$apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
398+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
399+
// This is optional, `GuzzleHttp\Client` will be used as default.
400+
new GuzzleHttp\Client(),
401+
$config
402+
);
403+
$campaignId = 789; // int | Id of the campaign or template
404+
405+
try {
406+
$result = $apiInstance->getSharedTemplateUrl($campaignId);
407+
print_r($result);
408+
} catch (Exception $e) {
409+
echo 'Exception when calling EmailCampaignsApi->getSharedTemplateUrl: ', $e->getMessage(), PHP_EOL;
410+
}
411+
?>
412+
```
413+
414+
### Parameters
415+
416+
Name | Type | Description | Notes
417+
------------- | ------------- | ------------- | -------------
418+
**campaignId** | **int**| Id of the campaign or template |
419+
420+
### Return type
421+
422+
[**\SendinBlue\Client\Model\GetSharedTemplateUrl**](../Model/GetSharedTemplateUrl.md)
423+
424+
### Authorization
425+
426+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
427+
428+
### HTTP request headers
429+
430+
- **Content-Type**: application/json
431+
- **Accept**: application/json
432+
433+
[[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)
434+
315435
# **sendEmailCampaignNow**
316436
> sendEmailCampaignNow($campaignId)
317437
318-
Send an email campaign id of the campaign immediately
438+
Send an email campaign immediately, based on campaignId
319439

320440
### Example
321441
```php

‎docs/Api/ResellerApi.md‎

Lines changed: 69 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Method | HTTP request | Description
1111
[**deleteChildDomain**](ResellerApi.md#deleteChildDomain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
1212
[**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
1313
[**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
14+
[**getChildAccountCreationStatus**](ResellerApi.md#getChildAccountCreationStatus) | **GET** /reseller/children/{childAuthKey}/accountCreationStatus | Returns the status of reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
1415
[**getChildDomains**](ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
1516
[**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
1617
[**getResellerChilds**](ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Gets the list of all reseller&#39;s children accounts
@@ -164,7 +165,7 @@ $apiInstance = new SendinBlue\Client\Api\ResellerApi(
164165
$config
165166
);
166167
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
167-
$addChildDomain = new \SendinBlue\Client\Model\AddChildDomain(); // \SendinBlue\Client\Model\AddChildDomain | Sender domain to add for a specific child account
168+
$addChildDomain = new \SendinBlue\Client\Model\AddChildDomain(); // \SendinBlue\Client\Model\AddChildDomain | Sender domain to add for a specific child account. This will not be displayed to the parent account.
168169

169170
try {
170171
$apiInstance->createChildDomain($childAuthKey, $addChildDomain);
@@ -179,7 +180,7 @@ try {
179180
Name | Type | Description | Notes
180181
------------- | ------------- | ------------- | -------------
181182
**childAuthKey** | **string**| auth key of reseller&#39;s child |
182-
**addChildDomain** | [**\SendinBlue\Client\Model\AddChildDomain**](../Model/AddChildDomain.md)| Sender domain to add for a specific child account |
183+
**addChildDomain** | [**\SendinBlue\Client\Model\AddChildDomain**](../Model/AddChildDomain.md)| Sender domain to add for a specific child account. This will not be displayed to the parent account. |
183184

184185
### Return type
185186

@@ -425,6 +426,63 @@ void (empty response body)
425426

426427
[[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)
427428

429+
# **getChildAccountCreationStatus**
430+
> \SendinBlue\Client\Model\GetChildAccountCreationStatus getChildAccountCreationStatus($childAuthKey)
431+
432+
Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
433+
434+
### Example
435+
```php
436+
<?php
437+
require_once(__DIR__ . '/vendor/autoload.php');
438+
439+
// Configure API key authorization: api-key
440+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
441+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
442+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
443+
// Configure API key authorization: partner-key
444+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
445+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
446+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
447+
448+
$apiInstance = new SendinBlue\Client\Api\ResellerApi(
449+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
450+
// This is optional, `GuzzleHttp\Client` will be used as default.
451+
new GuzzleHttp\Client(),
452+
$config
453+
);
454+
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
455+
456+
try {
457+
$result = $apiInstance->getChildAccountCreationStatus($childAuthKey);
458+
print_r($result);
459+
} catch (Exception $e) {
460+
echo 'Exception when calling ResellerApi->getChildAccountCreationStatus: ', $e->getMessage(), PHP_EOL;
461+
}
462+
?>
463+
```
464+
465+
### Parameters
466+
467+
Name | Type | Description | Notes
468+
------------- | ------------- | ------------- | -------------
469+
**childAuthKey** | **string**| auth key of reseller&#39;s child |
470+
471+
### Return type
472+
473+
[**\SendinBlue\Client\Model\GetChildAccountCreationStatus**](../Model/GetChildAccountCreationStatus.md)
474+
475+
### Authorization
476+
477+
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
478+
479+
### HTTP request headers
480+
481+
- **Content-Type**: application/json
482+
- **Accept**: application/json
483+
484+
[[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)
485+
428486
# **getChildDomains**
429487
> \SendinBlue\Client\Model\GetChildDomains getChildDomains($childAuthKey)
430488
@@ -540,7 +598,7 @@ Name | Type | Description | Notes
540598
[[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)
541599

542600
# **getResellerChilds**
543-
> \SendinBlue\Client\Model\GetChildrenList getResellerChilds()
601+
> \SendinBlue\Client\Model\GetChildrenList getResellerChilds($limit, $offset)
544602
545603
Gets the list of all reseller's children accounts
546604

@@ -564,9 +622,11 @@ $apiInstance = new SendinBlue\Client\Api\ResellerApi(
564622
new GuzzleHttp\Client(),
565623
$config
566624
);
625+
$limit = 10; // int | Number of documents for child accounts information per page
626+
$offset = 0; // int | Index of the first document in the page
567627

568628
try {
569-
$result = $apiInstance->getResellerChilds();
629+
$result = $apiInstance->getResellerChilds($limit, $offset);
570630
print_r($result);
571631
} catch (Exception $e) {
572632
echo 'Exception when calling ResellerApi->getResellerChilds: ', $e->getMessage(), PHP_EOL;
@@ -575,7 +635,11 @@ try {
575635
```
576636

577637
### Parameters
578-
This endpoint does not need any parameter.
638+
639+
Name | Type | Description | Notes
640+
------------- | ------------- | ------------- | -------------
641+
**limit** | **int**| Number of documents for child accounts information per page | [optional] [default to 10]
642+
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
579643

580644
### Return type
581645

0 commit comments

Comments
 (0)