Skip to content

Commit c07feac

Browse files
Merge pull request #14 from sendinblue/feature_updated_swagger_sync
Type object fix in get sms/email campaigns call
2 parents a141e18 + 09097a7 commit c07feac

Some content is hidden

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

47 files changed

+1163
-497
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Class | Method | HTTP request | Description
103103
*ContactsApi* | [**get_list**](docs/ContactsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
104104
*ContactsApi* | [**get_lists**](docs/ContactsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
105105
*ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
106-
*ContactsApi* | [**remove_contact_to_list**](docs/ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
106+
*ContactsApi* | [**remove_contact_from_list**](docs/ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
107107
*ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
108108
*ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
109109
*ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
@@ -132,19 +132,19 @@ Class | Method | HTTP request | Description
132132
*ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get the lists in a folder
133133
*ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get the details of a list
134134
*ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
135-
*ListsApi* | [**remove_contact_to_list**](docs/ListsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
135+
*ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
136136
*ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
137137
*ProcessApi* | [**get_process**](docs/ProcessApi.md#get_process) | **GET** /processes/{processId} | Return the informations for a process
138138
*ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
139-
*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
140-
*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
139+
*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
140+
*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
141141
*ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
142-
*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
143-
*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
144-
*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
142+
*ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
143+
*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
144+
*ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
145145
*ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
146-
*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
147-
*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
146+
*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
147+
*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
148148
*SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
149149
*SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
150150
*SMSCampaignsApi* | [**get_sms_campaign**](docs/SMSCampaignsApi.md#get_sms_campaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign
@@ -186,8 +186,8 @@ Class | Method | HTTP request | Description
186186

187187
## Documentation For Models
188188

189+
- [AddContactToList](docs/AddContactToList.md)
189190
- [AddCredits](docs/AddCredits.md)
190-
- [AddRemoveContactToList](docs/AddRemoveContactToList.md)
191191
- [CreateAttribute](docs/CreateAttribute.md)
192192
- [CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
193193
- [CreateChild](docs/CreateChild.md)
@@ -197,6 +197,7 @@ Class | Method | HTTP request | Description
197197
- [CreateEmailCampaignSender](docs/CreateEmailCampaignSender.md)
198198
- [CreateList](docs/CreateList.md)
199199
- [CreateModel](docs/CreateModel.md)
200+
- [CreateReseller](docs/CreateReseller.md)
200201
- [CreateSender](docs/CreateSender.md)
201202
- [CreateSenderIps](docs/CreateSenderIps.md)
202203
- [CreateSenderModel](docs/CreateSenderModel.md)
@@ -223,8 +224,9 @@ Class | Method | HTTP request | Description
223224
- [GetCampaignRecipients](docs/GetCampaignRecipients.md)
224225
- [GetCampaignStats](docs/GetCampaignStats.md)
225226
- [GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
227+
- [GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
228+
- [GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
226229
- [GetChildInfoCredits](docs/GetChildInfoCredits.md)
227-
- [GetChildInfoIps](docs/GetChildInfoIps.md)
228230
- [GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
229231
- [GetChildrenList](docs/GetChildrenList.md)
230232
- [GetClient](docs/GetClient.md)
@@ -289,6 +291,7 @@ Class | Method | HTTP request | Description
289291
- [RemainingCreditModel](docs/RemainingCreditModel.md)
290292
- [RemainingCreditModelChild](docs/RemainingCreditModelChild.md)
291293
- [RemainingCreditModelReseller](docs/RemainingCreditModelReseller.md)
294+
- [RemoveContactFromList](docs/RemoveContactFromList.md)
292295
- [RemoveCredits](docs/RemoveCredits.md)
293296
- [RequestContactExport](docs/RequestContactExport.md)
294297
- [RequestContactImport](docs/RequestContactImport.md)

docs/AddRemoveContactToList.md renamed to docs/AddContactToList.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# AddRemoveContactToList
1+
# AddContactToList
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**emails** | **list[str]** | Emails to add or remove from a list | [optional]
6+
**emails** | **list[str]** | Emails to add to a list | [optional]
77

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

docs/AddCredits.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-
**sms** | **int** | SMS credits to be added to the child account | [optional]
7-
**email** | **int** | Email credits to be added to the child account | [optional]
6+
**sms** | **int** | Required if email credits are empty. SMS credits to be added to the child account | [optional]
7+
**email** | **int** | Required if sms credits are empty. Email credits to be added to the child account | [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/ContactsApi.md

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

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

7373
### Return type
7474

@@ -1039,8 +1039,8 @@ Name | Type | Description | Notes
10391039

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

1042-
# **remove_contact_to_list**
1043-
> PostContactInfo remove_contact_to_list(list_id, contact_emails)
1042+
# **remove_contact_from_list**
1043+
> PostContactInfo remove_contact_from_list(list_id, contact_emails)
10441044
10451045
Remove existing contacts from a list
10461046

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

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

10741074
### Parameters
10751075

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

10811081
### Return type
10821082

docs/GetChildInfoIps.md renamed to docs/CreateReseller.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# GetChildInfoIps
1+
# CreateReseller
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**id** | **int** | ID of the IP |
7-
**ip** | **str** | IP associated to the child account user |
6+
**auth_key** | **str** | AuthKey of Reseller child created |
87

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

docs/GetChildInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Name | Type | Description | Notes
1010
**credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) | | [optional]
1111
**statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) | | [optional]
1212
**password** | **str** | The encrypted password of child account |
13-
**ips** | [**list[GetChildInfoIps]**](GetChildInfoIps.md) | IP(s) associated to a child account user | [optional]
14-
**api_keys** | [**list[GetChildInfoApiKeys]**](GetChildInfoApiKeys.md) | API Keys associated to child account | [optional]
13+
**ips** | **list[str]** | IP(s) associated to a child account user | [optional]
14+
**api_keys** | [**GetChildInfoApiKeys**](GetChildInfoApiKeys.md) | | [optional]
1515

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

docs/GetChildInfoApiKeys.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | Name of the key |
7-
**key** | **str** | API Key |
8-
**secret** | **str** | Secret Key associated to the API Key (in case v1 Key is used only) | [optional]
6+
**v2** | [**list[GetChildInfoApiKeysV2]**](GetChildInfoApiKeysV2.md) | |
7+
**v3** | [**list[GetChildInfoApiKeysV3]**](GetChildInfoApiKeysV3.md) | | [optional]
98

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

docs/GetChildInfoApiKeysV2.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetChildInfoApiKeysV2
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | Name of the key for version 2 |
7+
**key** | **str** | API Key for version 2 |
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/GetChildInfoApiKeysV3.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetChildInfoApiKeysV3
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | Name of the key for version 3 |
7+
**key** | **str** | API Key for version 3 |
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/GetEmailCampaign.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
2323
**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]
2424
**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]
2525
**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]
26+
**recipients** | **object** | |
27+
**statistics** | **object** | |
2628

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

docs/GetSmsCampaign.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
1212
**sender** | **str** | Sender of the SMS Campaign |
1313
**created_at** | **datetime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1414
**modified_at** | **datetime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
15+
**recipients** | **object** | |
16+
**statistics** | **object** | |
1517

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

0 commit comments

Comments
 (0)