Skip to content

Commit 93ef62d

Browse files
ruudy-sibruudy-sib
committed
AP-950:Wrapper update for version 7.0.0 and added user-agent
1 parent e0dcd00 commit 93ef62d

Some content is hidden

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

53 files changed

+1490
-383
lines changed

‎docs/AbTestCampaignResult.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
99
**open_rate** | **str** | Open rate for current winning version | [optional]
1010
**click_rate** | **str** | Click rate for current winning version | [optional]
1111
**winning_version_rate** | **str** | Open/Click rate for the winner version | [optional]
12+
**statistics** | [**AbTestCampaignResultStatistics**](AbTestCampaignResultStatistics.md) | | [optional]
13+
**clicked_links** | [**AbTestCampaignResultClickedLinks**](AbTestCampaignResultClickedLinks.md) | | [optional]
1214

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

‎docs/AbTestCampaignResultClickedLinks.md

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

‎docs/AbTestCampaignResultStatistics.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# AbTestCampaignResultStatistics
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**openers** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
7+
**clicks** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
8+
**unsubscribed** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
9+
**hard_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
10+
**soft_bounces** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
11+
**complaints** | [**AbTestVersionStats**](AbTestVersionStats.md) | |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

‎docs/AbTestVersionClicks.md

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

‎docs/AbTestVersionClicksInner.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AbTestVersionClicksInner
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**link** | **str** | URL of the link |
7+
**clicks_count** | **float** | Number of times a link is clicked |
8+
**click_rate** | **str** | Percentage of clicks of link with respect to total clicks |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/AbTestVersionStats.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AbTestVersionStats
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**version_a** | **str** | percentage of an event for version A |
7+
**version_b** | **str** | percentage of an event for version B |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/AddContactToList.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**emails** | **list[str]** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
6+
**emails** | **list[str]** | Mandatory if IDs are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
7+
**ids** | **list[int]** | Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
78

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

‎docs/ContactsApi.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Method | HTTP request | Description
1111
[**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
1212
[**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
1313
[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
14-
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{email} | Delete a contact
14+
[**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /contacts/{identifier} | Delete a contact
1515
[**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
1616
[**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
1717
[**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
18-
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{email} | Get a contact's details
19-
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{email}/campaignStats | Get email campaigns' statistics for a contact
18+
[**get_contact_info**](ContactsApi.md#get_contact_info) | **GET** /contacts/{identifier} | Get a contact's details
19+
[**get_contact_stats**](ContactsApi.md#get_contact_stats) | **GET** /contacts/{identifier}/campaignStats | Get email campaigns' statistics for a contact
2020
[**get_contacts**](ContactsApi.md#get_contacts) | **GET** /contacts | Get all the contacts
2121
[**get_contacts_from_list**](ContactsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
2222
[**get_folder**](ContactsApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
@@ -28,7 +28,7 @@ Method | HTTP request | Description
2828
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
2929
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
3030
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
31-
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Update a contact
31+
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
3232
[**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
3333
[**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
3434

@@ -60,7 +60,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
6060
# create an instance of the API class
6161
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
6262
list_id = 789 # int | Id of the list
63-
contact_emails = sib_api_v3_sdk.AddContactToList() # AddContactToList | Emails addresses of the contacts
63+
contact_emails = sib_api_v3_sdk.AddContactToList() # AddContactToList | Emails addresses OR IDs of the contacts
6464

6565
try:
6666
# Add existing contacts to a list
@@ -75,7 +75,7 @@ except ApiException as e:
7575
Name | Type | Description | Notes
7676
------------- | ------------- | ------------- | -------------
7777
**list_id** | **int**| Id of the list |
78-
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |
78+
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses OR IDs of the contacts |
7979

8080
### Return type
8181

@@ -438,7 +438,7 @@ void (empty response body)
438438
[[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)
439439

440440
# **delete_contact**
441-
> delete_contact(email)
441+
> delete_contact(identifier)
442442
443443
Delete a contact
444444

@@ -463,11 +463,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
463463

464464
# create an instance of the API class
465465
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
466-
email = 'email_example' # str | Email (urlencoded) of the contact
466+
identifier = 'identifier_example' # str | Email (urlencoded) OR ID of the contact
467467

468468
try:
469469
# Delete a contact
470-
api_instance.delete_contact(email)
470+
api_instance.delete_contact(identifier)
471471
except ApiException as e:
472472
print("Exception when calling ContactsApi->delete_contact: %s\n" % e)
473473
```
@@ -476,7 +476,7 @@ except ApiException as e:
476476

477477
Name | Type | Description | Notes
478478
------------- | ------------- | ------------- | -------------
479-
**email** | **str**| Email (urlencoded) of the contact |
479+
**identifier** | **str**| Email (urlencoded) OR ID of the contact |
480480

481481
### Return type
482482

@@ -659,7 +659,7 @@ This endpoint does not need any parameter.
659659
[[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)
660660

661661
# **get_contact_info**
662-
> GetExtendedContactDetails get_contact_info(email)
662+
> GetExtendedContactDetails get_contact_info(identifier)
663663
664664
Get a contact's details
665665

@@ -684,11 +684,11 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
684684

685685
# create an instance of the API class
686686
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
687-
email = 'email_example' # str | Email (urlencoded) of the contact OR its SMS attribute value
687+
identifier = 'identifier_example' # str | Email (urlencoded) OR ID of the contact OR its SMS attribute value
688688

689689
try:
690690
# Get a contact's details
691-
api_response = api_instance.get_contact_info(email)
691+
api_response = api_instance.get_contact_info(identifier)
692692
pprint(api_response)
693693
except ApiException as e:
694694
print("Exception when calling ContactsApi->get_contact_info: %s\n" % e)
@@ -698,7 +698,7 @@ except ApiException as e:
698698

699699
Name | Type | Description | Notes
700700
------------- | ------------- | ------------- | -------------
701-
**email** | **str**| Email (urlencoded) of the contact OR its SMS attribute value |
701+
**identifier** | **str**| Email (urlencoded) OR ID of the contact OR its SMS attribute value |
702702

703703
### Return type
704704

@@ -716,7 +716,7 @@ Name | Type | Description | Notes
716716
[[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)
717717

718718
# **get_contact_stats**
719-
> GetContactCampaignStats get_contact_stats(email, start_date=start_date, end_date=end_date)
719+
> GetContactCampaignStats get_contact_stats(identifier, start_date=start_date, end_date=end_date)
720720
721721
Get email campaigns' statistics for a contact
722722

@@ -741,13 +741,13 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
741741

742742
# create an instance of the API class
743743
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
744-
email = 'email_example' # str | Email address (urlencoded) of the contact
744+
identifier = 'identifier_example' # str | Email (urlencoded) OR ID of the contact
745745
start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate (optional)
746746
end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate (optional)
747747

748748
try:
749749
# Get email campaigns' statistics for a contact
750-
api_response = api_instance.get_contact_stats(email, start_date=start_date, end_date=end_date)
750+
api_response = api_instance.get_contact_stats(identifier, start_date=start_date, end_date=end_date)
751751
pprint(api_response)
752752
except ApiException as e:
753753
print("Exception when calling ContactsApi->get_contact_stats: %s\n" % e)
@@ -757,7 +757,7 @@ except ApiException as e:
757757

758758
Name | Type | Description | Notes
759759
------------- | ------------- | ------------- | -------------
760-
**email** | **str**| Email address (urlencoded) of the contact |
760+
**identifier** | **str**| Email (urlencoded) OR ID of the contact |
761761
**start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional]
762762
**end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional]
763763

@@ -1279,7 +1279,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
12791279
# create an instance of the API class
12801280
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
12811281
list_id = 789 # int | Id of the list
1282-
contact_emails = sib_api_v3_sdk.RemoveContactFromList() # RemoveContactFromList | Emails adresses of the contact
1282+
contact_emails = sib_api_v3_sdk.RemoveContactFromList() # RemoveContactFromList | Emails addresses OR IDs of the contacts
12831283

12841284
try:
12851285
# Delete a contact from a list
@@ -1294,7 +1294,7 @@ except ApiException as e:
12941294
Name | Type | Description | Notes
12951295
------------- | ------------- | ------------- | -------------
12961296
**list_id** | **int**| Id of the list |
1297-
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |
1297+
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails addresses OR IDs of the contacts |
12981298

12991299
### Return type
13001300

@@ -1431,7 +1431,7 @@ void (empty response body)
14311431
[[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)
14321432

14331433
# **update_contact**
1434-
> update_contact(email, update_contact)
1434+
> update_contact(identifier, update_contact)
14351435
14361436
Update a contact
14371437

@@ -1456,12 +1456,12 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'
14561456

14571457
# create an instance of the API class
14581458
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
1459-
email = 'email_example' # str | Email (urlencoded) of the contact
1459+
identifier = 'identifier_example' # str | Email (urlencoded) OR ID of the contact
14601460
update_contact = sib_api_v3_sdk.UpdateContact() # UpdateContact | Values to update a contact
14611461

14621462
try:
14631463
# Update a contact
1464-
api_instance.update_contact(email, update_contact)
1464+
api_instance.update_contact(identifier, update_contact)
14651465
except ApiException as e:
14661466
print("Exception when calling ContactsApi->update_contact: %s\n" % e)
14671467
```
@@ -1470,7 +1470,7 @@ except ApiException as e:
14701470

14711471
Name | Type | Description | Notes
14721472
------------- | ------------- | ------------- | -------------
1473-
**email** | **str**| Email (urlencoded) of the contact |
1473+
**identifier** | **str**| Email (urlencoded) OR ID of the contact |
14741474
**update_contact** | [**UpdateContact**](UpdateContact.md)| Values to update a contact |
14751475

14761476
### Return type

‎docs/CreateDoiContact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**include_list_ids** | **list[int]** | Lists under user account where contact should be added |
99
**exclude_list_ids** | **list[int]** | Lists under user account where contact should not be added | [optional]
1010
**template_id** | **int** | Id of the Double opt-in (DOI) template |
11-
**redirection_url** | **str** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. | [optional]
11+
**redirection_url** | **str** | URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}. |
1212

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

‎docs/CreateSmsCampaign.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 campaign |
7-
**sender** | **str** | Name of the sender. The number of characters is limited to 11 |
7+
**sender** | **str** | Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters** |
88
**content** | **str** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS |
99
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
1010
**scheduled_at** | **datetime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]

‎docs/CreateWebhook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**url** | **str** | URL of the webhook |
77
**description** | **str** | Description of the webhook | [optional]
8-
**events** | **list[str]** | Events triggering the webhook. Possible values for Transactional type webhook – sent, request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition & delivered |
8+
**events** | **list[str]** | Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` and possible values for Marketing type webhook – `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` |
99
**type** | **str** | Type of the webhook | [optional] [default to 'transactional']
1010

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

0 commit comments

Comments
 (0)