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
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@ Class | Method | HTTP request | Description

- [AddCredits](docs/AddCredits.md)
- [AddRemoveContactToList](docs/AddRemoveContactToList.md)
- [CreaUpdateFolder](docs/CreaUpdateFolder.md)
- [CreateAttribute](docs/CreateAttribute.md)
- [CreateAttributeEnumemaration](docs/CreateAttributeEnumemaration.md)
- [CreateChild](docs/CreateChild.md)
Expand All @@ -203,6 +202,7 @@ Class | Method | HTTP request | Description
- [CreateSmtpEmail](docs/CreateSmtpEmail.md)
- [CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
- [CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
- [CreateUpdateFolder](docs/CreateUpdateFolder.md)
- [CreateWebhook](docs/CreateWebhook.md)
- [CreatedProcessId](docs/CreatedProcessId.md)
- [DeleteHardbounces](docs/DeleteHardbounces.md)
Expand Down Expand Up @@ -259,8 +259,6 @@ Class | Method | HTTP request | Description
- [GetIpsFromSender](docs/GetIpsFromSender.md)
- [GetList](docs/GetList.md)
- [GetLists](docs/GetLists.md)
- [GetListsFolder](docs/GetListsFolder.md)
- [GetListsLists](docs/GetListsLists.md)
- [GetProcess](docs/GetProcess.md)
- [GetProcesses](docs/GetProcesses.md)
- [GetReports](docs/GetReports.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/AttributesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.AttributesApi()
attribute_id = 'attribute_id_example' # str | id of the attribute
attribute_id = 789 # int | id of the attribute

try:
# Deletes an attribute
Expand All @@ -93,7 +93,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attribute_id** | **str**| id of the attribute |
**attribute_id** | **int**| id of the attribute |

### Return type

Expand Down
64 changes: 32 additions & 32 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
list_id = 789 # int | Id of the list
contact_emails = sib_api_v3_sdk.AddRemoveContactToList() # AddRemoveContactToList | Emails addresses of the contacts

try:
Expand All @@ -65,7 +65,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **str**| Id of the list |
**list_id** | **int**| Id of the list |
**contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |

### Return type
Expand Down Expand Up @@ -186,7 +186,7 @@ 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)

# **create_folder**
> CreateModel create_folder(name)
> CreateModel create_folder(create_folder)

Create a folder

Expand All @@ -205,11 +205,11 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
name = sib_api_v3_sdk.CreaUpdateFolder() # CreaUpdateFolder | Name of the folder
create_folder = sib_api_v3_sdk.CreateUpdateFolder() # CreateUpdateFolder | Name of the folder

try:
# Create a folder
api_response = api_instance.create_folder(name)
api_response = api_instance.create_folder(create_folder)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactsApi->create_folder: %s\n" % e)
Expand All @@ -219,7 +219,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
**create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |

### Return type

Expand Down Expand Up @@ -307,7 +307,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
attribute_id = 'attribute_id_example' # str | id of the attribute
attribute_id = 789 # int | id of the attribute

try:
# Deletes an attribute
Expand All @@ -320,7 +320,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attribute_id** | **str**| id of the attribute |
**attribute_id** | **int**| id of the attribute |

### Return type

Expand Down Expand Up @@ -357,7 +357,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
folder_id = 'folder_id_example' # str | Id of the folder
folder_id = 789 # int | Id of the folder

try:
# Delete a folder (and all its lists)
Expand All @@ -370,7 +370,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**folder_id** | **str**| Id of the folder |
**folder_id** | **int**| Id of the folder |

### Return type

Expand Down Expand Up @@ -407,7 +407,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
list_id = 789 # int | Id of the list

try:
# Delete a list
Expand All @@ -420,7 +420,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **str**| Id of the list |
**list_id** | **int**| Id of the list |

### Return type

Expand Down Expand Up @@ -659,8 +659,8 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
modified_since = 'modified_since_example' # str | Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss) (optional)
list_id = 789 # int | Id of the list
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional)
limit = 50 # int | Number of documents per page (optional) (default to 50)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)

Expand All @@ -676,8 +676,8 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **str**| Id of the list |
**modified_since** | **str**| Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss) | [optional]
**list_id** | **int**| Id of the list |
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**limit** | **int**| Number of documents per page | [optional] [default to 50]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]

Expand Down Expand Up @@ -716,7 +716,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
folder_id = 'folder_id_example' # str | id of the folder
folder_id = 789 # int | id of the folder

try:
# Returns folder details
Expand All @@ -730,7 +730,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**folder_id** | **str**| id of the folder |
**folder_id** | **int**| id of the folder |

### Return type

Expand Down Expand Up @@ -767,7 +767,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
folder_id = 'folder_id_example' # str | Id of the folder
folder_id = 789 # int | Id of the folder
limit = 10 # int | Number of documents per page (optional) (default to 10)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)

Expand All @@ -783,7 +783,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**folder_id** | **str**| Id of the folder |
**folder_id** | **int**| Id of the folder |
**limit** | **int**| Number of documents per page | [optional] [default to 10]
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]

Expand Down Expand Up @@ -875,7 +875,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
list_id = 789 # int | Id of the list

try:
# Get the details of a list
Expand All @@ -889,7 +889,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **str**| Id of the list |
**list_id** | **int**| Id of the list |

### Return type

Expand Down Expand Up @@ -1032,7 +1032,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
list_id = 789 # int | Id of the list
contact_emails = sib_api_v3_sdk.AddRemoveContactToList() # AddRemoveContactToList | Emails adresses of the contact

try:
Expand All @@ -1047,7 +1047,7 @@ except ApiException as e:

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

### Return type
Expand Down Expand Up @@ -1171,7 +1171,7 @@ void (empty response body)
[[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)

# **update_folder**
> update_folder(folder_id, name)
> update_folder(folder_id, update_folder)

Update a contact folder

Expand All @@ -1190,12 +1190,12 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
folder_id = 'folder_id_example' # str | Id of the folder
name = sib_api_v3_sdk.CreaUpdateFolder() # CreaUpdateFolder | Name of the folder
folder_id = 789 # int | Id of the folder
update_folder = sib_api_v3_sdk.CreateUpdateFolder() # CreateUpdateFolder | Name of the folder

try:
# Update a contact folder
api_instance.update_folder(folder_id, name)
api_instance.update_folder(folder_id, update_folder)
except ApiException as e:
print("Exception when calling ContactsApi->update_folder: %s\n" % e)
```
Expand All @@ -1204,8 +1204,8 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**folder_id** | **str**| Id of the folder |
**name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
**folder_id** | **int**| Id of the folder |
**update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |

### Return type

Expand Down Expand Up @@ -1242,7 +1242,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.ContactsApi()
list_id = 'list_id_example' # str | Id of the list
list_id = 789 # int | Id of the list
update_list = sib_api_v3_sdk.UpdateList() # UpdateList | Values to update a list

try:
Expand All @@ -1256,7 +1256,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**list_id** | **str**| Id of the list |
**list_id** | **int**| Id of the list |
**update_list** | [**UpdateList**](UpdateList.md)| Values to update a list |

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**name** | **str** | Name of the campaign |
**html_content** | **str** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
**html_url** | **str** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
**scheduled_at** | **str** | Sending date and time (YYYY-MM-DD HH:mm:ss) | [optional]
**scheduled_at** | **datetime** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**subject** | **str** | Subject of the campaign |
**reply_to** | **str** | Email on which the campaign recipients will be able to reply to | [optional]
**to_field** | **str** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**sender** | **str** | Name of the sender. The number of characters is limited to 11 |
**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 | [optional]
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
**scheduled_at** | **str** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional]
**scheduled_at** | **datetime** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [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
2 changes: 1 addition & 1 deletion docs/CreaUpdateFolder.md → docs/CreateUpdateFolder.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# CreaUpdateFolder
# CreateUpdateFolder

## Properties
Name | Type | Description | Notes
Expand Down
Loading