Skip to content

Commit 0b86513

Browse files
authored
Merge pull request #138 from sendinblue/feature_AP-1231
AP-1231 PHP wrapper update
2 parents 9eca202 + b5a24d4 commit 0b86513

File tree

83 files changed

+2405
-260
lines changed

Some content is hidden

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

83 files changed

+2405
-260
lines changed

docs/Api/ContactsApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -804,7 +804,7 @@ $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
807+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
808808

809809
try {
810810
$result = $apiInstance->getContacts($limit, $offset, $modifiedSince, $sort);
@@ -822,7 +822,7 @@ Name | Type | Description | Notes
822822
**limit** | **int**| Number of documents per page | [optional] [default to 50]
823823
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
824824
**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]
825+
**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]
826826

827827
### Return type
828828

@@ -868,7 +868,7 @@ $listId = 789; // int | Id of the list
868868
$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.
869869
$limit = 50; // int | Number of documents per page
870870
$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
871+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
872872

873873
try {
874874
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
@@ -887,7 +887,7 @@ Name | Type | Description | Notes
887887
**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]
888888
**limit** | **int**| Number of documents per page | [optional] [default to 50]
889889
**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]
890+
**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]
891891

892892
### Return type
893893

@@ -989,7 +989,7 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
989989
$folderId = 789; // int | Id of the folder
990990
$limit = 10; // int | Number of documents per page
991991
$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
992+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
993993

994994
try {
995995
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
@@ -1007,7 +1007,7 @@ Name | Type | Description | Notes
10071007
**folderId** | **int**| Id of the folder |
10081008
**limit** | **int**| Number of documents per page | [optional] [default to 10]
10091009
**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]
1010+
**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]
10111011

10121012
### Return type
10131013

@@ -1051,7 +1051,7 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
10511051
);
10521052
$limit = 10; // int | Number of documents per page
10531053
$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
1054+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
10551055

10561056
try {
10571057
$result = $apiInstance->getFolders($limit, $offset, $sort);
@@ -1068,7 +1068,7 @@ Name | Type | Description | Notes
10681068
------------- | ------------- | ------------- | -------------
10691069
**limit** | **int**| Number of documents per page | [default to 10]
10701070
**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]
1071+
**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]
10721072

10731073
### Return type
10741074

@@ -1169,7 +1169,7 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
11691169
);
11701170
$limit = 10; // int | Number of documents per page
11711171
$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
1172+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
11731173

11741174
try {
11751175
$result = $apiInstance->getLists($limit, $offset, $sort);
@@ -1186,7 +1186,7 @@ Name | Type | Description | Notes
11861186
------------- | ------------- | ------------- | -------------
11871187
**limit** | **int**| Number of documents per page | [optional] [default to 10]
11881188
**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]
1189+
**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]
11901190

11911191
### Return type
11921192

docs/Api/EmailCampaignsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ $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
341+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
342342

343343
try {
344344
$result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset, $sort);
@@ -359,7 +359,7 @@ Name | Type | Description | Notes
359359
**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]
360360
**limit** | **int**| Number of documents per page | [optional] [default to 500]
361361
**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]
362+
**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]
363363

364364
### Return type
365365

docs/Api/FoldersApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ $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
213+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
214214

215215
try {
216216
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
@@ -228,7 +228,7 @@ Name | Type | Description | Notes
228228
**folderId** | **int**| Id of the folder |
229229
**limit** | **int**| Number of documents per page | [optional] [default to 10]
230230
**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]
231+
**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]
232232

233233
### Return type
234234

@@ -272,7 +272,7 @@ $apiInstance = new SendinBlue\Client\Api\FoldersApi(
272272
);
273273
$limit = 10; // int | Number of documents per page
274274
$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
275+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
276276

277277
try {
278278
$result = $apiInstance->getFolders($limit, $offset, $sort);
@@ -289,7 +289,7 @@ Name | Type | Description | Notes
289289
------------- | ------------- | ------------- | -------------
290290
**limit** | **int**| Number of documents per page | [default to 10]
291291
**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]
292+
**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]
293293

294294
### Return type
295295

docs/Api/ListsApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ $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
219+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
220220

221221
try {
222222
$result = $apiInstance->getContactsFromList($listId, $modifiedSince, $limit, $offset, $sort);
@@ -235,7 +235,7 @@ Name | Type | Description | Notes
235235
**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]
236236
**limit** | **int**| Number of documents per page | [optional] [default to 50]
237237
**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]
238+
**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]
239239

240240
### Return type
241241

@@ -280,7 +280,7 @@ $apiInstance = new SendinBlue\Client\Api\ListsApi(
280280
$folderId = 789; // int | Id of the folder
281281
$limit = 10; // int | Number of documents per page
282282
$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
283+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
284284

285285
try {
286286
$result = $apiInstance->getFolderLists($folderId, $limit, $offset, $sort);
@@ -298,7 +298,7 @@ Name | Type | Description | Notes
298298
**folderId** | **int**| Id of the folder |
299299
**limit** | **int**| Number of documents per page | [optional] [default to 10]
300300
**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]
301+
**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]
302302

303303
### Return type
304304

@@ -399,7 +399,7 @@ $apiInstance = new SendinBlue\Client\Api\ListsApi(
399399
);
400400
$limit = 10; // int | Number of documents per page
401401
$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
402+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
403403

404404
try {
405405
$result = $apiInstance->getLists($limit, $offset, $sort);
@@ -416,7 +416,7 @@ Name | Type | Description | Notes
416416
------------- | ------------- | ------------- | -------------
417417
**limit** | **int**| Number of documents per page | [optional] [default to 10]
418418
**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]
419+
**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]
420420

421421
### Return type
422422

docs/Api/ProcessApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ $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
95+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
9696

9797
try {
9898
$result = $apiInstance->getProcesses($limit, $offset, $sort);
@@ -109,7 +109,7 @@ Name | Type | Description | Notes
109109
------------- | ------------- | ------------- | -------------
110110
**limit** | **int**| Number limitation for the result returned | [optional] [default to 10]
111111
**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]
112+
**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]
113113

114114
### Return type
115115

docs/Api/SMSCampaignsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ $startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandator
216216
$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 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' )
217217
$limit = 500; // int | Number limitation for the result returned
218218
$offset = 0; // int | Beginning point in the list to retrieve from.
219-
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation
219+
$sort = "desc"; // string | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
220220

221221
try {
222222
$result = $apiInstance->getSmsCampaigns($status, $startDate, $endDate, $limit, $offset, $sort);
@@ -236,7 +236,7 @@ Name | Type | Description | Notes
236236
**endDate** | **\DateTime**| 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]
237237
**limit** | **int**| Number limitation for the result returned | [optional] [default to 500]
238238
**offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0]
239-
**sort** | **string**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
239+
**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]
240240

241241
### Return type
242242

0 commit comments

Comments
 (0)