Skip to content

Commit c4c2e9e

Browse files
authored
Merge pull request #59 from sendinblue/feature_dec28122020
AP-1069: Updated version from 7.0.0 to 7.1.0 and added user-agent conditionally
2 parents e057a09 + f6c28a9 commit c4c2e9e

Some content is hidden

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

59 files changed

+843
-242
lines changed

docs/BlockDomain.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# BlockDomain
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domain** | **str** | name of the domain to be blocked |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/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
# **get_contacts**
780-
> GetContacts get_contacts(limit=limit, offset=offset, modified_since=modified_since)
780+
> GetContacts get_contacts(limit=limit, offset=offset, modified_since=modified_since, sort=sort)
781781
782782
Get all the contacts
783783

@@ -805,10 +805,11 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration
805805
limit = 50 # int | Number of documents per page (optional) (default to 50)
806806
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
807807
modified_since = '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. (optional)
808+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
808809

809810
try:
810811
# Get all the contacts
811-
api_response = api_instance.get_contacts(limit=limit, offset=offset, modified_since=modified_since)
812+
api_response = api_instance.get_contacts(limit=limit, offset=offset, modified_since=modified_since, sort=sort)
812813
pprint(api_response)
813814
except ApiException as e:
814815
print("Exception when calling ContactsApi->get_contacts: %s\n" % e)
@@ -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
**modified_since** | **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** | **str**| 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
# **get_contacts_from_list**
841-
> GetContacts get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset)
843+
> GetContacts get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset, sort=sort)
842844
843845
Get contacts in a list
844846

@@ -867,10 +869,11 @@ list_id = 789 # int | Id of the list
867869
modified_since = '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. (optional)
868870
limit = 50 # int | Number of documents per page (optional) (default to 50)
869871
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
872+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
870873

871874
try:
872875
# Get contacts in a list
873-
api_response = api_instance.get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset)
876+
api_response = api_instance.get_contacts_from_list(list_id, modified_since=modified_since, limit=limit, offset=offset, sort=sort)
874877
pprint(api_response)
875878
except ApiException as e:
876879
print("Exception when calling ContactsApi->get_contacts_from_list: %s\n" % e)
@@ -884,6 +887,7 @@ Name | Type | Description | Notes
884887
**modified_since** | **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** | **str**| 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
# **get_folder_lists**
961-
> GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset)
965+
> GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset, sort=sort)
962966
963967
Get lists in a folder
964968

@@ -986,10 +990,11 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration
986990
folder_id = 789 # int | Id of the folder
987991
limit = 10 # int | Number of documents per page (optional) (default to 10)
988992
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
993+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
989994

990995
try:
991996
# Get lists in a folder
992-
api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset)
997+
api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset, sort=sort)
993998
pprint(api_response)
994999
except ApiException as e:
9951000
print("Exception when calling ContactsApi->get_folder_lists: %s\n" % e)
@@ -1002,6 +1007,7 @@ Name | Type | Description | Notes
10021007
**folder_id** | **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** | **str**| 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
# **get_folders**
1022-
> GetFolders get_folders(limit, offset)
1028+
> GetFolders get_folders(limit, offset, sort=sort)
10231029
10241030
Get all folders
10251031

@@ -1046,10 +1052,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
10461052
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
10471053
limit = 10 # int | Number of documents per page (default to 10)
10481054
offset = 0 # int | Index of the first document of the page (default to 0)
1055+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
10491056

10501057
try:
10511058
# Get all folders
1052-
api_response = api_instance.get_folders(limit, offset)
1059+
api_response = api_instance.get_folders(limit, offset, sort=sort)
10531060
pprint(api_response)
10541061
except ApiException as e:
10551062
print("Exception when calling ContactsApi->get_folders: %s\n" % e)
@@ -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** | **str**| 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
# **get_lists**
1138-
> GetLists get_lists(limit=limit, offset=offset)
1146+
> GetLists get_lists(limit=limit, offset=offset, sort=sort)
11391147
11401148
Get all the lists
11411149

@@ -1162,10 +1170,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
11621170
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
11631171
limit = 10 # int | Number of documents per page (optional) (default to 10)
11641172
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
1173+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
11651174

11661175
try:
11671176
# Get all the lists
1168-
api_response = api_instance.get_lists(limit=limit, offset=offset)
1177+
api_response = api_instance.get_lists(limit=limit, offset=offset, sort=sort)
11691178
pprint(api_response)
11701179
except ApiException as e:
11711180
print("Exception when calling ContactsApi->get_lists: %s\n" % e)
@@ -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** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
11801190

11811191
### Return type
11821192

docs/CreateSmtpTemplateSender.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**name** | **str** | Name of the sender. If not passed, will be set to default | [optional]
7-
**email** | **str** | Email of the sender |
7+
**email** | **str** | Email of the sender | [optional]
88
**id** | **int** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/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
# **get_email_campaigns**
311-
> GetEmailCampaigns get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)
311+
> GetEmailCampaigns get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset, sort=sort)
312312
313313
Return all your created email campaigns
314314

@@ -339,10 +339,11 @@ start_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if endDate is us
339339
end_date = '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' ) (optional)
340340
limit = 500 # int | Number of documents per page (optional) (default to 500)
341341
offset = 0 # int | Index of the first document in the page (optional) (default to 0)
342+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
342343

343344
try:
344345
# Return all your created email campaigns
345-
api_response = api_instance.get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset)
346+
api_response = api_instance.get_email_campaigns(type=type, status=status, start_date=start_date, end_date=end_date, limit=limit, offset=offset, sort=sort)
346347
pprint(api_response)
347348
except ApiException as e:
348349
print("Exception when calling EmailCampaignsApi->get_email_campaigns: %s\n" % e)
@@ -358,6 +359,7 @@ Name | Type | Description | Notes
358359
**end_date** | **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** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
361363

362364
### Return type
363365

docs/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
# **get_folder_lists**
186-
> GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset)
186+
> GetFolderLists get_folder_lists(folder_id, limit=limit, offset=offset, sort=sort)
187187
188188
Get lists in a folder
189189

@@ -211,10 +211,11 @@ api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)
211211
folder_id = 789 # int | Id of the folder
212212
limit = 10 # int | Number of documents per page (optional) (default to 10)
213213
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
214+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
214215

215216
try:
216217
# Get lists in a folder
217-
api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset)
218+
api_response = api_instance.get_folder_lists(folder_id, limit=limit, offset=offset, sort=sort)
218219
pprint(api_response)
219220
except ApiException as e:
220221
print("Exception when calling FoldersApi->get_folder_lists: %s\n" % e)
@@ -227,6 +228,7 @@ Name | Type | Description | Notes
227228
**folder_id** | **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** | **str**| 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
# **get_folders**
247-
> GetFolders get_folders(limit, offset)
249+
> GetFolders get_folders(limit, offset, sort=sort)
248250
249251
Get all folders
250252

@@ -271,10 +273,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
271273
api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration))
272274
limit = 10 # int | Number of documents per page (default to 10)
273275
offset = 0 # int | Index of the first document of the page (default to 0)
276+
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc)
274277

275278
try:
276279
# Get all folders
277-
api_response = api_instance.get_folders(limit, offset)
280+
api_response = api_instance.get_folders(limit, offset, sort=sort)
278281
pprint(api_response)
279282
except ApiException as e:
280283
print("Exception when calling FoldersApi->get_folders: %s\n" % e)
@@ -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** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]
289293

290294
### Return type
291295

docs/GetBlockedDomains.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GetBlockedDomains
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domains** | **list[str]** | List of all blocked domains |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/GetChildDomain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**domain** | **str** | Sender domain |
7-
**active** | **bool** | indicates whether a domain is verified or not |
6+
**domain** | **str** | Sender domain | [optional]
7+
**active** | **bool** | indicates whether a domain is verified or not | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/GetChildrenList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**children** | **list[object]** | Your children's account information | [optional]
7-
**count** | **int** | Number of child accounts |
7+
**count** | **int** | Number of child accounts | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/GetEmailCampaign.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Name | Type | Description | Notes
2121
**footer** | **str** | Footer of the campaign |
2222
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
2323
**reply_to** | **str** | Email defined as the \"Reply to\" of the campaign |
24-
**to_field** | **str** | Customisation of the \"to\" field of the campaign |
24+
**to_field** | **str** | Customisation of the \"to\" field of the campaign | [optional]
2525
**html_content** | **str** | HTML content of the campaign |
2626
**share_link** | **str** | Link to share the campaign on social medias | [optional]
27-
**tag** | **str** | Tag of the campaign |
27+
**tag** | **str** | Tag of the campaign | [optional]
2828
**created_at** | **datetime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
2929
**modified_at** | **datetime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
3030
**inline_image_activation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]

docs/GetEmailCampaigns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaigns** | **list[object]** | | [optional]
7-
**count** | **int** | Number of Email campaigns retrieved |
7+
**count** | **int** | Number of Email campaigns retrieved | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/GetEmailEventReportEvents.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**ip** | **str** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
1414
**link** | **str** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
1515
**_from** | **str** | Sender email from which the emails are sent | [optional]
16+
**template_id** | **int** | ID of the template (only available if the email is template based) | [optional]
1617

1718
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1819

0 commit comments

Comments
 (0)