Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Class | Method | HTTP request | Description
*ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
*ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
*ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
*ContactsApi* | [**remove_contact_to_list**](docs/ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
*ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
*ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
*ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
*ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
Expand Down Expand Up @@ -132,19 +132,19 @@ Class | Method | HTTP request | Description
*ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
*ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
*ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
*ListsApi* | [**remove_contact_to_list**](docs/ListsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
*ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
*ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
*ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
*ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
*ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childId}/credits/add | Add Email and/or SMS credits to a specific child account
*ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childId}/ips/associate | Associate a dedicated IP to the child
*ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
*ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
*ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
*ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child
*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
*ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
*ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
*ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
*ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
*ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
*SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
*SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
*SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
Expand Down Expand Up @@ -186,8 +186,8 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [AddContactToList](docs/AddContactToList.md)
- [AddCredits](docs/AddCredits.md)
- [AddRemoveContactToList](docs/AddRemoveContactToList.md)
- [CreateAttribute](docs/CreateAttribute.md)
- [CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
- [CreateChild](docs/CreateChild.md)
Expand All @@ -197,6 +197,7 @@ Class | Method | HTTP request | Description
- [CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
- [CreateList](docs/CreateList.md)
- [CreateModel](docs/CreateModel.md)
- [CreateReseller](docs/CreateReseller.md)
- [CreateSender](docs/CreateSender.md)
- [CreateSenderIps](docs/CreateSenderIps.md)
- [CreateSenderModel](docs/CreateSenderModel.md)
Expand All @@ -223,8 +224,9 @@ Class | Method | HTTP request | Description
- [GetCampaignRecipients](docs/GetCampaignRecipients.md)
- [GetCampaignStats](docs/GetCampaignStats.md)
- [GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
- [GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
- [GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
- [GetChildInfoCredits](docs/GetChildInfoCredits.md)
- [GetChildInfoIps](docs/GetChildInfoIps.md)
- [GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
- [GetChildrenList](docs/GetChildrenList.md)
- [GetClient](docs/GetClient.md)
Expand Down Expand Up @@ -289,6 +291,7 @@ Class | Method | HTTP request | Description
- [RemainingCreditModel](docs/RemainingCreditModel.md)
- [RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
- [RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
- [RemoveContactFromList](docs/RemoveContactFromList.md)
- [RemoveCredits](docs/RemoveCredits.md)
- [RequestContactExport](docs/RequestContactExport.md)
- [RequestContactImport](docs/RequestContactImport.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/AddRemoveContactToList.md → docs/AddContactToList.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AddRemoveContactToList
# AddContactToList

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**emails** | **list[str]** | Emails to add or remove from a list | [optional]
**emails** | **list[str]** | Emails to add to a list | [optional]

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

Expand Down
4 changes: 2 additions & 2 deletions docs/AddCredits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sms** | **int** | SMS credits to be added to the child account | [optional]
**email** | **int** | Email credits to be added to the child account | [optional]
**sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional]
**email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [optional]

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

Expand Down
18 changes: 9 additions & 9 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Method | HTTP request | Description
[**get_list**](ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
[**get_lists**](ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
[**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
[**remove_contact_to_list**](ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
[**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
[**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
[**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
Expand Down Expand Up @@ -53,7 +53,7 @@ configuration.api_key['api-key'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
list_id = 789 # int | Id of the list
contact_emails = sib_api_v3_sdk.AddRemoveContactToList() # AddRemoveContactToList | Emails addresses of the contacts
contact_emails = sib_api_v3_sdk.AddContactToList() # AddContactToList | Emails addresses of the contacts

try:
# Add existing contacts to a list
Expand All @@ -68,7 +68,7 @@ except ApiException as e:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **int**| Id of the list |
**contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
**contact_emails** | [**AddContactToList**](AddContactToList.md)| Emails addresses of the contacts |

### Return type

Expand Down Expand Up @@ -1039,8 +1039,8 @@ Name | Type | Description | Notes

[[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)

# **remove_contact_to_list**
> PostContactInfo remove_contact_to_list(list_id, contact_emails)
# **remove_contact_from_list**
> PostContactInfo remove_contact_from_list(list_id, contact_emails)

Remove existing contacts from a list

Expand All @@ -1061,22 +1061,22 @@ configuration.api_key['api-key'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
list_id = 789 # int | Id of the list
contact_emails = sib_api_v3_sdk.AddRemoveContactToList() # AddRemoveContactToList | Emails adresses of the contact
contact_emails = sib_api_v3_sdk.RemoveContactFromList() # RemoveContactFromList | Emails adresses of the contact

try:
# Remove existing contacts from a list
api_response = api_instance.remove_contact_to_list(list_id, contact_emails)
api_response = api_instance.remove_contact_from_list(list_id, contact_emails)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactsApi->remove_contact_to_list: %s\n" % e)
print("Exception when calling ContactsApi->remove_contact_from_list: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **int**| Id of the list |
**contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
**contact_emails** | [**RemoveContactFromList**](RemoveContactFromList.md)| Emails adresses of the contact |

### Return type

Expand Down
5 changes: 2 additions & 3 deletions docs/GetChildInfoIps.md → docs/CreateReseller.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# GetChildInfoIps
# CreateReseller

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | ID of the IP |
**ip** | **str** | IP associated to the child account user |
**auth_key** | **str** | AuthKey of Reseller child created |

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

Expand Down
4 changes: 2 additions & 2 deletions docs/GetChildInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Name | Type | Description | Notes
**credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional]
**statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional]
**password** | **str** | The encrypted password of child account |
**ips** | [**list[GetChildInfoIps]**](GetChildInfoIps.md) | IP(s) associated to a child account user | [optional]
**api_keys** | [**list[GetChildInfoApiKeys]**](GetChildInfoApiKeys.md) | API Keys associated to child account | [optional]
**ips** | **list[str]** | IP(s) associated to a child account user | [optional]
**api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional]

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

Expand Down
5 changes: 2 additions & 3 deletions docs/GetChildInfoApiKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the key |
**key** | **str** | API Key |
**secret** | **str** | Secret Key associated to the API Key (in case v1 Key is used only) | [optional]
**v2** | [**list[GetChildInfoApiKeysV2]**](GetChildInfoApiKeysV2.md) | |
**v3** | [**list[GetChildInfoApiKeysV3]**](GetChildInfoApiKeysV3.md) | | [optional]

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

Expand Down
11 changes: 11 additions & 0 deletions docs/GetChildInfoApiKeysV2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetChildInfoApiKeysV2

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the key for version 2 |
**key** | **str** | API Key for version 2 |

[[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 changes: 11 additions & 0 deletions docs/GetChildInfoApiKeysV3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetChildInfoApiKeysV3

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the key for version 3 |
**key** | **str** | API Key for version 3 |

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


2 changes: 2 additions & 0 deletions docs/GetEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Name | Type | Description | Notes
**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]
**mirror_active** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional]
**recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional]
**recipients** | **object** | |
**statistics** | **object** | |

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

Expand Down
2 changes: 2 additions & 0 deletions docs/GetSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Name | Type | Description | Notes
**sender** | **str** | Sender of the SMS Campaign |
**created_at** | **datetime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **datetime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**recipients** | **object** | |
**statistics** | **object** | |

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

Expand Down
Loading