Skip to content

Commit 9eca202

Browse files
rajatsibrajatsib
authored
Merge pull request #135 from sendinblue/feature_AP-1066
AP-1066 Updated version to 7.3.0 and added user-agent conditionally
2 parents 4b7c9b1 + d15f657 commit 9eca202

File tree

66 files changed

+1730
-410
lines changed

Some content is hidden

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

66 files changed

+1730
-410
lines changed

‎docs/Api/ContactsApi.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ Name | Type | Description | Notes
777777
[[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)
778778

779779
# **getContacts**
780-
> \SendinBlue\Client\Model\GetContacts getContacts($limit, $offset, $modifiedSince)
780+
> \SendinBlue\Client\Model\GetContacts getContacts($limit, $offset, $modifiedSince, $sort)
781781
782782
Get all the contacts
783783

@@ -804,9 +804,10 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
804804
$limit = 50; // int | Number of documents per page
805805
$offset = 0; // int | Index of the first document of the page
806806
$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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.
807+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
807808

808809
try {
809-
$result = $apiInstance->getContacts($limit, $offset, $modifiedSince);
810+
$result = $apiInstance->getContacts($limit, $offset, $modifiedSince, $sort);
810811
print_r($result);
811812
} catch (Exception $e) {
812813
echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL;
@@ -821,6 +822,7 @@ Name | Type | Description | Notes
821822
**limit** | **int**| Number of documents per page | [optional] [default to 50]
822823
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
823824
**modifiedSince** | **\DateTime**| 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]
825+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
824826

825827
### Return type
826828

@@ -838,7 +840,7 @@ Name | Type | Description | Notes
838840
[[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)
839841

840842
# **getContactsFromList**
841-
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset)
843+
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort)
842844
843845
Get contacts in a list
844846

@@ -866,9 +868,10 @@ $listId = 789; // int | Id of the list
866868
$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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.
867869
$limit = 50; // int | Number of documents per page
868870
$offset = 0; // int | Index of the first document of the page
871+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
869872

870873
try {
871-
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset);
874+
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
872875
print_r($result);
873876
} catch (Exception $e) {
874877
echo 'Exception when calling ContactsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL;
@@ -884,6 +887,7 @@ Name | Type | Description | Notes
884887
**modifiedSince** | **\DateTime**| 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]
885888
**limit** | **int**| Number of documents per page | [optional] [default to 50]
886889
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
890+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
887891

888892
### Return type
889893

@@ -958,7 +962,7 @@ Name | Type | Description | Notes
958962
[[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)
959963

960964
# **getFolderLists**
961-
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset)
965+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
962966
963967
Get lists in a folder
964968

@@ -985,9 +989,10 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
985989
$folderId = 789; // int | Id of the folder
986990
$limit = 10; // int | Number of documents per page
987991
$offset = 0; // int | Index of the first document of the page
992+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
988993

989994
try {
990-
$result = $apiInstance->getFolderLists($folderId, $limit, $offset);
995+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
991996
print_r($result);
992997
} catch (Exception $e) {
993998
echo 'Exception when calling ContactsApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
@@ -1002,6 +1007,7 @@ Name | Type | Description | Notes
10021007
**folderId** | **int**| Id of the folder |
10031008
**limit** | **int**| Number of documents per page | [optional] [default to 10]
10041009
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
1010+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
10051011

10061012
### Return type
10071013

@@ -1019,7 +1025,7 @@ Name | Type | Description | Notes
10191025
[[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)
10201026

10211027
# **getFolders**
1022-
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset)
1028+
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset, $sort)
10231029
10241030
Get all folders
10251031

@@ -1045,9 +1051,10 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
10451051
);
10461052
$limit = 10; // int | Number of documents per page
10471053
$offset = 0; // int | Index of the first document of the page
1054+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
10481055

10491056
try {
1050-
$result = $apiInstance->getFolders($limit, $offset);
1057+
$result = $apiInstance->getFolders($limit, $offset, $sort);
10511058
print_r($result);
10521059
} catch (Exception $e) {
10531060
echo 'Exception when calling ContactsApi->getFolders: ', $e->getMessage(), PHP_EOL;
@@ -1061,6 +1068,7 @@ Name | Type | Description | Notes
10611068
------------- | ------------- | ------------- | -------------
10621069
**limit** | **int**| Number of documents per page | [default to 10]
10631070
**offset** | **int**| Index of the first document of the page | [default to 0]
1071+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
10641072

10651073
### Return type
10661074

@@ -1135,7 +1143,7 @@ Name | Type | Description | Notes
11351143
[[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)
11361144

11371145
# **getLists**
1138-
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset)
1146+
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset, $sort)
11391147
11401148
Get all the lists
11411149

@@ -1161,9 +1169,10 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
11611169
);
11621170
$limit = 10; // int | Number of documents per page
11631171
$offset = 0; // int | Index of the first document of the page
1172+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
11641173

11651174
try {
1166-
$result = $apiInstance->getLists($limit, $offset);
1175+
$result = $apiInstance->getLists($limit, $offset, $sort);
11671176
print_r($result);
11681177
} catch (Exception $e) {
11691178
echo 'Exception when calling ContactsApi->getLists: ', $e->getMessage(), PHP_EOL;
@@ -1177,6 +1186,7 @@ Name | Type | Description | Notes
11771186
------------- | ------------- | ------------- | -------------
11781187
**limit** | **int**| Number of documents per page | [optional] [default to 10]
11791188
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
1189+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
11801190

11811191
### Return type
11821192

‎docs/Api/EmailCampaignsApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ Name | Type | Description | Notes
308308
[[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)
309309

310310
# **getEmailCampaigns**
311-
> \SendinBlue\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset)
311+
> \SendinBlue\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset, $sort)
312312
313313
Return all your created email campaigns
314314

@@ -338,9 +338,10 @@ $startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandator
338338
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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' )
339339
$limit = 500; // int | Number of documents per page
340340
$offset = 0; // int | Index of the first document in the page
341+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
341342

342343
try {
343-
$result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset);
344+
$result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset, $sort);
344345
print_r($result);
345346
} catch (Exception $e) {
346347
echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
@@ -358,6 +359,7 @@ Name | Type | Description | Notes
358359
**endDate** | **\DateTime**| 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]
359360
**limit** | **int**| Number of documents per page | [optional] [default to 500]
360361
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
362+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
361363

362364
### Return type
363365

‎docs/Api/FoldersApi.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
183183
[[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)
184184

185185
# **getFolderLists**
186-
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset)
186+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
187187
188188
Get lists in a folder
189189

@@ -210,9 +210,10 @@ $apiInstance = new SendinBlue\Client\Api\FoldersApi(
210210
$folderId = 789; // int | Id of the folder
211211
$limit = 10; // int | Number of documents per page
212212
$offset = 0; // int | Index of the first document of the page
213+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
213214

214215
try {
215-
$result = $apiInstance->getFolderLists($folderId, $limit, $offset);
216+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
216217
print_r($result);
217218
} catch (Exception $e) {
218219
echo 'Exception when calling FoldersApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
@@ -227,6 +228,7 @@ Name | Type | Description | Notes
227228
**folderId** | **int**| Id of the folder |
228229
**limit** | **int**| Number of documents per page | [optional] [default to 10]
229230
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
231+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
230232

231233
### Return type
232234

@@ -244,7 +246,7 @@ Name | Type | Description | Notes
244246
[[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)
245247

246248
# **getFolders**
247-
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset)
249+
> \SendinBlue\Client\Model\GetFolders getFolders($limit, $offset, $sort)
248250
249251
Get all folders
250252

@@ -270,9 +272,10 @@ $apiInstance = new SendinBlue\Client\Api\FoldersApi(
270272
);
271273
$limit = 10; // int | Number of documents per page
272274
$offset = 0; // int | Index of the first document of the page
275+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
273276

274277
try {
275-
$result = $apiInstance->getFolders($limit, $offset);
278+
$result = $apiInstance->getFolders($limit, $offset, $sort);
276279
print_r($result);
277280
} catch (Exception $e) {
278281
echo 'Exception when calling FoldersApi->getFolders: ', $e->getMessage(), PHP_EOL;
@@ -286,6 +289,7 @@ Name | Type | Description | Notes
286289
------------- | ------------- | ------------- | -------------
287290
**limit** | **int**| Number of documents per page | [default to 10]
288291
**offset** | **int**| Index of the first document of the page | [default to 0]
292+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
289293

290294
### Return type
291295

‎docs/Api/ListsApi.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ void (empty response body)
188188
[[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)
189189

190190
# **getContactsFromList**
191-
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset)
191+
> \SendinBlue\Client\Model\GetContacts getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort)
192192
193193
Get contacts in a list
194194

@@ -216,9 +216,10 @@ $listId = 789; // int | Id of the list
216216
$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 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.
217217
$limit = 50; // int | Number of documents per page
218218
$offset = 0; // int | Index of the first document of the page
219+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
219220

220221
try {
221-
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset);
222+
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
222223
print_r($result);
223224
} catch (Exception $e) {
224225
echo 'Exception when calling ListsApi->getContactsFromList: ', $e->getMessage(), PHP_EOL;
@@ -234,6 +235,7 @@ Name | Type | Description | Notes
234235
**modifiedSince** | **\DateTime**| 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]
235236
**limit** | **int**| Number of documents per page | [optional] [default to 50]
236237
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
238+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
237239

238240
### Return type
239241

@@ -251,7 +253,7 @@ Name | Type | Description | Notes
251253
[[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)
252254

253255
# **getFolderLists**
254-
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset)
256+
> \SendinBlue\Client\Model\GetFolderLists getFolderLists($folderId, $limit, $offset, $sort)
255257
256258
Get lists in a folder
257259

@@ -278,9 +280,10 @@ $apiInstance = new SendinBlue\Client\Api\ListsApi(
278280
$folderId = 789; // int | Id of the folder
279281
$limit = 10; // int | Number of documents per page
280282
$offset = 0; // int | Index of the first document of the page
283+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
281284

282285
try {
283-
$result = $apiInstance->getFolderLists($folderId, $limit, $offset);
286+
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
284287
print_r($result);
285288
} catch (Exception $e) {
286289
echo 'Exception when calling ListsApi->getFolderLists: ', $e->getMessage(), PHP_EOL;
@@ -295,6 +298,7 @@ Name | Type | Description | Notes
295298
**folderId** | **int**| Id of the folder |
296299
**limit** | **int**| Number of documents per page | [optional] [default to 10]
297300
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
301+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
298302

299303
### Return type
300304

@@ -369,7 +373,7 @@ Name | Type | Description | Notes
369373
[[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)
370374

371375
# **getLists**
372-
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset)
376+
> \SendinBlue\Client\Model\GetLists getLists($limit, $offset, $sort)
373377
374378
Get all the lists
375379

@@ -395,9 +399,10 @@ $apiInstance = new SendinBlue\Client\Api\ListsApi(
395399
);
396400
$limit = 10; // int | Number of documents per page
397401
$offset = 0; // int | Index of the first document of the page
402+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
398403

399404
try {
400-
$result = $apiInstance->getLists($limit, $offset);
405+
$result = $apiInstance->getLists($limit, $offset, $sort);
401406
print_r($result);
402407
} catch (Exception $e) {
403408
echo 'Exception when calling ListsApi->getLists: ', $e->getMessage(), PHP_EOL;
@@ -411,6 +416,7 @@ Name | Type | Description | Notes
411416
------------- | ------------- | ------------- | -------------
412417
**limit** | **int**| Number of documents per page | [optional] [default to 10]
413418
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
419+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
414420

415421
### Return type
416422

‎docs/Api/ProcessApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Name | Type | Description | Notes
6666
[[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)
6767

6868
# **getProcesses**
69-
> \SendinBlue\Client\Model\GetProcesses getProcesses($limit, $offset)
69+
> \SendinBlue\Client\Model\GetProcesses getProcesses($limit, $offset, $sort)
7070
7171
Return all the processes for your account
7272

@@ -92,9 +92,10 @@ $apiInstance = new SendinBlue\Client\Api\ProcessApi(
9292
);
9393
$limit = 10; // int | Number limitation for the result returned
9494
$offset = 0; // int | Beginning point in the list to retrieve from.
95+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
9596

9697
try {
97-
$result = $apiInstance->getProcesses($limit, $offset);
98+
$result = $apiInstance->getProcesses($limit, $offset, $sort);
9899
print_r($result);
99100
} catch (Exception $e) {
100101
echo 'Exception when calling ProcessApi->getProcesses: ', $e->getMessage(), PHP_EOL;
@@ -108,6 +109,7 @@ Name | Type | Description | Notes
108109
------------- | ------------- | ------------- | -------------
109110
**limit** | **int**| Number limitation for the result returned | [optional] [default to 10]
110111
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
112+
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
111113

112114
### Return type
113115

0 commit comments

Comments
 (0)