Skip to content

Commit 3ee7e48

Browse files
php wrapper updated
1 parent 5f57580 commit 3ee7e48

File tree

86 files changed

+3819
-256
lines changed

Some content is hidden

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

86 files changed

+3819
-256
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ Class | Method | HTTP request | Description
204204
*TransactionalEmailsApi* | [**getAggregatedSmtpReport**](docs/Api/TransactionalEmailsApi.md#getaggregatedsmtpreport) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
205205
*TransactionalEmailsApi* | [**getBlockedDomains**](docs/Api/TransactionalEmailsApi.md#getblockeddomains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
206206
*TransactionalEmailsApi* | [**getEmailEventReport**](docs/Api/TransactionalEmailsApi.md#getemaileventreport) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
207+
*TransactionalEmailsApi* | [**getScheduledEmailByBatchId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbybatchid) | **GET** /smtp/emailStatus/{batchId} | Fetch scheduled emails by batchId
208+
*TransactionalEmailsApi* | [**getScheduledEmailById**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbyid) | **DELETE** /smtp/email/{identifier} | Delete scheduled emails by batchId or messageId
209+
*TransactionalEmailsApi* | [**getScheduledEmailByMessageId**](docs/Api/TransactionalEmailsApi.md#getscheduledemailbymessageid) | **GET** /smtp/emailStatus/{messageId} | Fetch scheduled email by messageId
207210
*TransactionalEmailsApi* | [**getSmtpReport**](docs/Api/TransactionalEmailsApi.md#getsmtpreport) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
208211
*TransactionalEmailsApi* | [**getSmtpTemplate**](docs/Api/TransactionalEmailsApi.md#getsmtptemplate) | **GET** /smtp/templates/{templateId} | Returns the template information
209212
*TransactionalEmailsApi* | [**getSmtpTemplates**](docs/Api/TransactionalEmailsApi.md#getsmtptemplates) | **GET** /smtp/templates | Get the list of email templates
@@ -261,6 +264,7 @@ Class | Method | HTTP request | Description
261264
- [CreateSmtpTemplate](docs/Model/CreateSmtpTemplate.md)
262265
- [CreateSmtpTemplateSender](docs/Model/CreateSmtpTemplateSender.md)
263266
- [CreateSubAccount](docs/Model/CreateSubAccount.md)
267+
- [CreateSubAccountResponse](docs/Model/CreateSubAccountResponse.md)
264268
- [CreateUpdateContactModel](docs/Model/CreateUpdateContactModel.md)
265269
- [CreateUpdateFolder](docs/Model/CreateUpdateFolder.md)
266270
- [CreateWebhook](docs/Model/CreateWebhook.md)
@@ -333,6 +337,9 @@ Class | Method | HTTP request | Description
333337
- [GetProcesses](docs/Model/GetProcesses.md)
334338
- [GetReports](docs/Model/GetReports.md)
335339
- [GetReportsReports](docs/Model/GetReportsReports.md)
340+
- [GetScheduledEmailByBatchId](docs/Model/GetScheduledEmailByBatchId.md)
341+
- [GetScheduledEmailByBatchIdBatches](docs/Model/GetScheduledEmailByBatchIdBatches.md)
342+
- [GetScheduledEmailByMessageId](docs/Model/GetScheduledEmailByMessageId.md)
336343
- [GetSendersList](docs/Model/GetSendersList.md)
337344
- [GetSendersListIps](docs/Model/GetSendersListIps.md)
338345
- [GetSendersListSenders](docs/Model/GetSendersListSenders.md)
@@ -361,6 +368,7 @@ Class | Method | HTTP request | Description
361368
- [GetTransacSmsReportReports](docs/Model/GetTransacSmsReportReports.md)
362369
- [GetWebhook](docs/Model/GetWebhook.md)
363370
- [GetWebhooks](docs/Model/GetWebhooks.md)
371+
- [InlineResponse201](docs/Model/InlineResponse201.md)
364372
- [ManageIp](docs/Model/ManageIp.md)
365373
- [MasterDetailsResponse](docs/Model/MasterDetailsResponse.md)
366374
- [MasterDetailsResponseBillingInfo](docs/Model/MasterDetailsResponseBillingInfo.md)

docs/Api/CRMApi.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ Get file details
2929
<?php
3030
require_once(__DIR__ . '/vendor/autoload.php');
3131

32-
// Configure API key authorization: api-key
33-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
32+
// Configure API key authorization: api-Key
33+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('api-Key', 'YOUR_API_KEY');
3434
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
35-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
36-
// Configure API key authorization: partner-key
37-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
35+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('api-Key', 'Bearer');
36+
// Configure API key authorization: partnerKey
37+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('partnerKey', 'YOUR_API_KEY');
3838
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
39-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
39+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('partnerKey', 'Bearer');
4040

4141
$apiInstance = new SendinBlue\Client\Api\CRMApi(
4242
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
6767

6868
### Authorization
6969

70-
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
70+
[api-Key](../../README.md#api-Key), [partnerKey](../../README.md#partnerKey)
7171

7272
### HTTP request headers
7373

@@ -86,14 +86,14 @@ Delete a file
8686
<?php
8787
require_once(__DIR__ . '/vendor/autoload.php');
8888

89-
// Configure API key authorization: api-key
90-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
89+
// Configure API key authorization: api-Key
90+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('api-Key', 'YOUR_API_KEY');
9191
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
92-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
93-
// Configure API key authorization: partner-key
94-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
92+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('api-Key', 'Bearer');
93+
// Configure API key authorization: partnerKey
94+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('partnerKey', 'YOUR_API_KEY');
9595
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
96-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
96+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('partnerKey', 'Bearer');
9797

9898
$apiInstance = new SendinBlue\Client\Api\CRMApi(
9999
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -123,7 +123,7 @@ void (empty response body)
123123

124124
### Authorization
125125

126-
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
126+
[api-Key](../../README.md#api-Key), [partnerKey](../../README.md#partnerKey)
127127

128128
### HTTP request headers
129129

@@ -142,14 +142,14 @@ Download a file
142142
<?php
143143
require_once(__DIR__ . '/vendor/autoload.php');
144144

145-
// Configure API key authorization: api-key
146-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
145+
// Configure API key authorization: api-Key
146+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('api-Key', 'YOUR_API_KEY');
147147
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
148-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
149-
// Configure API key authorization: partner-key
150-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
148+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('api-Key', 'Bearer');
149+
// Configure API key authorization: partnerKey
150+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('partnerKey', 'YOUR_API_KEY');
151151
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
152-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
152+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('partnerKey', 'Bearer');
153153

154154
$apiInstance = new SendinBlue\Client\Api\CRMApi(
155155
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -179,7 +179,7 @@ void (empty response body)
179179

180180
### Authorization
181181

182-
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
182+
[api-Key](../../README.md#api-Key), [partnerKey](../../README.md#partnerKey)
183183

184184
### HTTP request headers
185185

@@ -198,14 +198,14 @@ Upload a file
198198
<?php
199199
require_once(__DIR__ . '/vendor/autoload.php');
200200

201-
// Configure API key authorization: api-key
202-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
201+
// Configure API key authorization: api-Key
202+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('api-Key', 'YOUR_API_KEY');
203203
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
204-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
205-
// Configure API key authorization: partner-key
206-
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
204+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('api-Key', 'Bearer');
205+
// Configure API key authorization: partnerKey
206+
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-Key('partnerKey', 'YOUR_API_KEY');
207207
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
208-
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
208+
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setapi-KeyPrefix('partnerKey', 'Bearer');
209209

210210
$apiInstance = new SendinBlue\Client\Api\CRMApi(
211211
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
238238

239239
### Authorization
240240

241-
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
241+
[api-Key](../../README.md#api-Key), [partnerKey](../../README.md#partnerKey)
242242

243243
### HTTP request headers
244244

@@ -649,7 +649,7 @@ Name | Type | Description | Notes
649649
[[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)
650650

651651
# **crmTasksPost**
652-
> \SendinBlue\Client\Model\Task crmTasksPost($body)
652+
> \SendinBlue\Client\Model\InlineResponse201 crmTasksPost($body)
653653
654654
Create a task
655655

@@ -692,7 +692,7 @@ Name | Type | Description | Notes
692692

693693
### Return type
694694

695-
[**\SendinBlue\Client\Model\Task**](../Model/Task.md)
695+
[**\SendinBlue\Client\Model\InlineResponse201**](../Model/InlineResponse201.md)
696696

697697
### Authorization
698698

docs/Api/MasterAccountApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ $apiInstance = new SendinBlue\Client\Api\MasterAccountApi(
9595
new GuzzleHttp\Client(),
9696
$config
9797
);
98-
$offset = 56; // int | Page number of sub-accounts listing
98+
$offset = 56; // int | Index of the first sub-account in the page
9999
$limit = 56; // int | Number of sub-accounts to be displayed on each page
100100

101101
try {
@@ -111,7 +111,7 @@ try {
111111

112112
Name | Type | Description | Notes
113113
------------- | ------------- | ------------- | -------------
114-
**offset** | **int**| Page number of sub-accounts listing |
114+
**offset** | **int**| Index of the first sub-account in the page |
115115
**limit** | **int**| Number of sub-accounts to be displayed on each page |
116116

117117
### Return type
@@ -190,7 +190,7 @@ void (empty response body)
190190
191191
Get sub-account details
192192

193-
This endpoint will provide the details of specified sub-account organization
193+
This endpoint will provide the details for the specified sub-account company
194194

195195
### Example
196196
```php
@@ -305,7 +305,7 @@ void (empty response body)
305305
[[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)
306306

307307
# **corporateSubAccountPost**
308-
> \SendinBlue\Client\Model\CreateModel corporateSubAccountPost($subAccountCreate)
308+
> \SendinBlue\Client\Model\CreateSubAccountResponse corporateSubAccountPost($subAccountCreate)
309309
310310
Create a new sub-account under a master account.
311311

@@ -350,7 +350,7 @@ Name | Type | Description | Notes
350350

351351
### Return type
352352

353-
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
353+
[**\SendinBlue\Client\Model\CreateSubAccountResponse**](../Model/CreateSubAccountResponse.md)
354354

355355
### Authorization
356356

@@ -368,7 +368,7 @@ Name | Type | Description | Notes
368368
369369
Generate SSO token to access Sendinblue
370370

371-
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token.
371+
This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
372372

373373
### Example
374374
```php

0 commit comments

Comments
 (0)