Skip to content

Wrapper generated for swagger-codegen version 3.0.5 #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2019
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.3.1
3.0.5
92 changes: 22 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ SendinBlue's API matches the [OpenAPI v2 definition](https://www.openapis.org/).
This PYTHON package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project and is reviewed and maintained by SendinBlue:

- API version: 3.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen

- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
For more information, please visit [https://account.sendinblue.com/support](https://account.sendinblue.com/support)

## Requirements.
Expand Down Expand Up @@ -62,6 +61,11 @@ configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'

# create an instance of the API class
api_instance = sib_api_v3_sdk.AccountApi(sib_api_v3_sdk.ApiClient(configuration))
Expand All @@ -72,7 +76,6 @@ try:
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->get_account: %s\n" % e)

```

## Documentation for API Endpoints
Expand Down Expand Up @@ -145,9 +148,9 @@ Class | Method | HTTP request | Description
*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* | [**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/{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
*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,76 +189,49 @@ Class | Method | HTTP request | Description
*WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get all webhooks
*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks/{webhookId} | Update a webhook


## Documentation For Models

- [AddContactToList](docs/AddContactToList.md)
- [AddCredits](docs/AddCredits.md)
- [CreateAttribute](docs/CreateAttribute.md)
- [CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
- [CreateChild](docs/CreateChild.md)
- [CreateContact](docs/CreateContact.md)
- [CreateEmailCampaign](docs/CreateEmailCampaign.md)
- [CreateEmailCampaignRecipients](docs/CreateEmailCampaignRecipients.md)
- [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)
- [CreateSmsCampaign](docs/CreateSmsCampaign.md)
- [CreateSmsCampaignRecipients](docs/CreateSmsCampaignRecipients.md)
- [CreateSmtpEmail](docs/CreateSmtpEmail.md)
- [CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
- [CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
- [CreateUpdateContactModel](docs/CreateUpdateContactModel.md)
- [CreateUpdateFolder](docs/CreateUpdateFolder.md)
- [CreateWebhook](docs/CreateWebhook.md)
- [CreatedProcessId](docs/CreatedProcessId.md)
- [DeleteHardbounces](docs/DeleteHardbounces.md)
- [EmailExportRecipients](docs/EmailExportRecipients.md)
- [ErrorModel](docs/ErrorModel.md)
- [GetAccountMarketingAutomation](docs/GetAccountMarketingAutomation.md)
- [GetAccountPlan](docs/GetAccountPlan.md)
- [GetAccountRelay](docs/GetAccountRelay.md)
- [GetAccountRelayData](docs/GetAccountRelayData.md)
- [GetAccount](docs/GetAccount.md)
- [GetAggregatedReport](docs/GetAggregatedReport.md)
- [GetAttributes](docs/GetAttributes.md)
- [GetAttributesAttributes](docs/GetAttributesAttributes.md)
- [GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
- [GetCampaignOverview](docs/GetCampaignOverview.md)
- [GetCampaignRecipients](docs/GetCampaignRecipients.md)
- [GetCampaignStats](docs/GetCampaignStats.md)
- [GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
- [GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
- [GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
- [GetChildInfoCredits](docs/GetChildInfoCredits.md)
- [GetChildInfoStatistics](docs/GetChildInfoStatistics.md)
- [GetChildInfo](docs/GetChildInfo.md)
- [GetChildrenList](docs/GetChildrenList.md)
- [GetClient](docs/GetClient.md)
- [GetContactCampaignStats](docs/GetContactCampaignStats.md)
- [GetContactCampaignStatsClicked](docs/GetContactCampaignStatsClicked.md)
- [GetContactCampaignStatsOpened](docs/GetContactCampaignStatsOpened.md)
- [GetContactCampaignStatsTransacAttributes](docs/GetContactCampaignStatsTransacAttributes.md)
- [GetContactCampaignStatsUnsubscriptions](docs/GetContactCampaignStatsUnsubscriptions.md)
- [GetContactDetails](docs/GetContactDetails.md)
- [GetContacts](docs/GetContacts.md)
- [GetEmailCampaign](docs/GetEmailCampaign.md)
- [GetEmailCampaigns](docs/GetEmailCampaigns.md)
- [GetEmailEventReport](docs/GetEmailEventReport.md)
- [GetEmailEventReportEvents](docs/GetEmailEventReportEvents.md)
- [GetExtendedCampaignOverviewSender](docs/GetExtendedCampaignOverviewSender.md)
- [GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
- [GetExtendedCampaignStats](docs/GetExtendedCampaignStats.md)
- [GetExtendedClientAddress](docs/GetExtendedClientAddress.md)
- [GetExtendedContactDetailsStatistics](docs/GetExtendedContactDetailsStatistics.md)
- [GetExtendedContactDetailsStatisticsClicked](docs/GetExtendedContactDetailsStatisticsClicked.md)
- [GetExtendedContactDetailsStatisticsLinks](docs/GetExtendedContactDetailsStatisticsLinks.md)
- [GetExtendedContactDetailsStatisticsMessagesSent](docs/GetExtendedContactDetailsStatisticsMessagesSent.md)
- [GetExtendedContactDetailsStatisticsOpened](docs/GetExtendedContactDetailsStatisticsOpened.md)
- [GetExtendedContactDetailsStatisticsUnsubscriptions](docs/GetExtendedContactDetailsStatisticsUnsubscriptions.md)
- [GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md)
- [GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription](docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md)
- [GetExtendedListCampaignStats](docs/GetExtendedListCampaignStats.md)
- [GetExtendedClient](docs/GetExtendedClient.md)
- [GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
- [GetExtendedList](docs/GetExtendedList.md)
- [GetFolder](docs/GetFolder.md)
- [GetFolderLists](docs/GetFolderLists.md)
- [GetFolders](docs/GetFolders.md)
Expand All @@ -268,77 +244,47 @@ Class | Method | HTTP request | Description
- [GetProcess](docs/GetProcess.md)
- [GetProcesses](docs/GetProcesses.md)
- [GetReports](docs/GetReports.md)
- [GetReportsReports](docs/GetReportsReports.md)
- [GetSendersList](docs/GetSendersList.md)
- [GetSendersListIps](docs/GetSendersListIps.md)
- [GetSendersListSenders](docs/GetSendersListSenders.md)
- [GetSmsCampaign](docs/GetSmsCampaign.md)
- [GetSmsCampaignOverview](docs/GetSmsCampaignOverview.md)
- [GetSmsCampaignStats](docs/GetSmsCampaignStats.md)
- [GetSmsCampaigns](docs/GetSmsCampaigns.md)
- [GetSmsEventReport](docs/GetSmsEventReport.md)
- [GetSmsEventReportEvents](docs/GetSmsEventReportEvents.md)
- [GetSmtpTemplateOverview](docs/GetSmtpTemplateOverview.md)
- [GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
- [GetSmtpTemplates](docs/GetSmtpTemplates.md)
- [GetStatsByDomain](docs/GetStatsByDomain.md)
- [GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
- [GetTransacSmsReport](docs/GetTransacSmsReport.md)
- [GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
- [GetWebhook](docs/GetWebhook.md)
- [GetWebhooks](docs/GetWebhooks.md)
- [ManageIp](docs/ManageIp.md)
- [PostContactInfo](docs/PostContactInfo.md)
- [PostContactInfoContacts](docs/PostContactInfoContacts.md)
- [PostSendFailed](docs/PostSendFailed.md)
- [PostSendSmsTestFailed](docs/PostSendSmsTestFailed.md)
- [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)
- [RequestContactImportNewList](docs/RequestContactImportNewList.md)
- [RequestSmsRecipientExport](docs/RequestSmsRecipientExport.md)
- [SendEmail](docs/SendEmail.md)
- [SendEmailAttachment](docs/SendEmailAttachment.md)
- [SendReport](docs/SendReport.md)
- [SendReportEmail](docs/SendReportEmail.md)
- [SendSms](docs/SendSms.md)
- [SendSmtpEmail](docs/SendSmtpEmail.md)
- [SendSmtpEmailAttachment](docs/SendSmtpEmailAttachment.md)
- [SendSmtpEmailBcc](docs/SendSmtpEmailBcc.md)
- [SendSmtpEmailCc](docs/SendSmtpEmailCc.md)
- [SendSmtpEmailReplyTo](docs/SendSmtpEmailReplyTo.md)
- [SendSmtpEmailSender](docs/SendSmtpEmailSender.md)
- [SendSmtpEmailTo](docs/SendSmtpEmailTo.md)
- [SendTemplateEmail](docs/SendTemplateEmail.md)
- [SendTestEmail](docs/SendTestEmail.md)
- [SendTestSms](docs/SendTestSms.md)
- [SendTransacSms](docs/SendTransacSms.md)
- [UpdateAttribute](docs/UpdateAttribute.md)
- [UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
- [UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
- [UpdateChild](docs/UpdateChild.md)
- [UpdateContact](docs/UpdateContact.md)
- [UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
- [UpdateEmailCampaignRecipients](docs/UpdateEmailCampaignRecipients.md)
- [UpdateEmailCampaignSender](docs/UpdateEmailCampaignSender.md)
- [UpdateList](docs/UpdateList.md)
- [UpdateSender](docs/UpdateSender.md)
- [UpdateSmsCampaign](docs/UpdateSmsCampaign.md)
- [UpdateSmtpTemplate](docs/UpdateSmtpTemplate.md)
- [UpdateSmtpTemplateSender](docs/UpdateSmtpTemplateSender.md)
- [UpdateWebhook](docs/UpdateWebhook.md)
- [GetChildInfo](docs/GetChildInfo.md)
- [GetExtendedCampaignOverview](docs/GetExtendedCampaignOverview.md)
- [GetExtendedClient](docs/GetExtendedClient.md)
- [GetExtendedContactDetails](docs/GetExtendedContactDetails.md)
- [GetExtendedList](docs/GetExtendedList.md)
- [GetSmsCampaign](docs/GetSmsCampaign.md)
- [GetAccount](docs/GetAccount.md)
- [GetEmailCampaign](docs/GetEmailCampaign.md)


## Documentation For Authorization

Expand All @@ -349,6 +295,12 @@ Class | Method | HTTP request | Description
- **API key parameter name**: api-key
- **Location**: HTTP header

## partner-key

- **Type**: API key
- **API key parameter name**: partner-key
- **Location**: HTTP header

## Support and Feedback

Be sure to visit the SendinBlue official [documentation website](https://sendinblue.readme.io/docs ) for additional information about our API.
Expand Down
3 changes: 1 addition & 2 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details


# **get_account**
> GetAccount get_account()

Expand Down Expand Up @@ -55,7 +54,7 @@ This endpoint does not need any parameter.

### HTTP request headers

- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json

[[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)
Expand Down
1 change: 0 additions & 1 deletion docs/AddContactToList.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ Name | Type | Description | Notes

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


1 change: 0 additions & 1 deletion docs/AddCredits.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ Name | Type | Description | Notes

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


33 changes: 16 additions & 17 deletions docs/AttributesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ Method | HTTP request | Description
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute


# **create_attribute**
> create_attribute(attribute_category, attribute_name, create_attribute)
> create_attribute(body, attribute_category, attribute_name)

Creates contact attribute

Expand All @@ -36,13 +35,13 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.AttributesApi(sib_api_v3_sdk.ApiClient(configuration))
body = sib_api_v3_sdk.CreateAttribute() # CreateAttribute | Values to create an attribute
attribute_category = 'attribute_category_example' # str | Category of the attribute
attribute_name = 'attribute_name_example' # str | Name of the attribute
create_attribute = sib_api_v3_sdk.CreateAttribute() # CreateAttribute | Values to create an attribute

try:
# Creates contact attribute
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
api_instance.create_attribute(body, attribute_category, attribute_name)
except ApiException as e:
print("Exception when calling AttributesApi->create_attribute: %s\n" % e)
```
Expand All @@ -51,9 +50,9 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attribute_category** | **str**| Category of the attribute |
**attribute_name** | **str**| Name of the attribute |
**create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
**body** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
**attribute_category** | [**str**](.md)| Category of the attribute |
**attribute_name** | [**str**](.md)| Name of the attribute |

### Return type

Expand Down Expand Up @@ -110,8 +109,8 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attribute_category** | **str**| Category of the attribute |
**attribute_name** | **str**| Name of the existing attribute |
**attribute_category** | [**str**](.md)| Category of the attribute |
**attribute_name** | [**str**](.md)| Name of the existing attribute |

### Return type

Expand All @@ -123,7 +122,7 @@ void (empty response body)

### HTTP request headers

- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json

[[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)
Expand Down Expand Up @@ -176,13 +175,13 @@ This endpoint does not need any parameter.

### HTTP request headers

- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json

[[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_attribute**
> update_attribute(attribute_category, attribute_name, update_attribute)
> update_attribute(body, attribute_category, attribute_name)

Updates contact attribute

Expand All @@ -207,13 +206,13 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = sib_api_v3_sdk.AttributesApi(sib_api_v3_sdk.ApiClient(configuration))
body = sib_api_v3_sdk.UpdateAttribute() # UpdateAttribute | Values to update an attribute
attribute_category = 'attribute_category_example' # str | Category of the attribute
attribute_name = 'attribute_name_example' # str | Name of the existing attribute
update_attribute = sib_api_v3_sdk.UpdateAttribute() # UpdateAttribute | Values to update an attribute

try:
# Updates contact attribute
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
api_instance.update_attribute(body, attribute_category, attribute_name)
except ApiException as e:
print("Exception when calling AttributesApi->update_attribute: %s\n" % e)
```
Expand All @@ -222,9 +221,9 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**attribute_category** | **str**| Category of the attribute |
**attribute_name** | **str**| Name of the existing attribute |
**update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
**body** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute |
**attribute_category** | [**str**](.md)| Category of the attribute |
**attribute_name** | [**str**](.md)| Name of the existing attribute |

### Return type

Expand Down
Loading