From 35443614a8829c17bdc7fa73b17a974f83f344e9 Mon Sep 17 00:00:00 2001 From: aakanksha-sib Date: Tue, 26 Feb 2019 11:01:18 +0530 Subject: [PATCH] Swagger updates for ab-test campaign functionality --- docs/AccountApi.md | 7 +- docs/AttributesApi.md | 28 ++- docs/ContactsApi.md | 182 ++++++++++++--- docs/CreateAttribute.md | 2 +- docs/CreateContact.md | 2 +- docs/CreateEmailCampaign.md | 12 +- docs/CreateSmtpTemplate.md | 2 +- docs/CreateUpdateContactModel.md | 2 +- docs/EmailCampaignsApi.md | 70 +++++- docs/FoldersApi.md | 42 +++- docs/GetCampaignOverview.md | 9 +- docs/GetContactDetails.md | 1 + docs/GetEmailCampaign.md | 9 +- docs/GetExtendedCampaignOverview.md | 9 +- docs/GetExtendedContactDetails.md | 1 + docs/ListsApi.md | 63 +++++- docs/ProcessApi.md | 14 +- docs/RequestContactExport.md | 2 +- docs/ResellerApi.md | 63 +++++- docs/SMSCampaignsApi.md | 70 +++++- docs/SMTPApi.md | 84 ++++++- docs/SendEmail.md | 6 +- docs/SendSmtpEmail.md | 8 +- docs/SendersApi.md | 42 +++- docs/TransactionalSMSApi.md | 28 ++- docs/UpdateAttribute.md | 2 +- docs/UpdateContact.md | 2 +- docs/UpdateEmailCampaign.md | 10 +- docs/UpdateSmtpTemplate.md | 2 +- docs/WebhooksApi.md | 35 ++- setup.py | 2 +- sib_api_v3_sdk/api/account_api.py | 2 +- sib_api_v3_sdk/api/attributes_api.py | 8 +- sib_api_v3_sdk/api/contacts_api.py | 52 ++--- sib_api_v3_sdk/api/email_campaigns_api.py | 20 +- sib_api_v3_sdk/api/folders_api.py | 12 +- sib_api_v3_sdk/api/lists_api.py | 18 +- sib_api_v3_sdk/api/process_api.py | 4 +- sib_api_v3_sdk/api/reseller_api.py | 18 +- sib_api_v3_sdk/api/senders_api.py | 12 +- sib_api_v3_sdk/api/sms_campaigns_api.py | 20 +- sib_api_v3_sdk/api/smtp_api.py | 24 +- sib_api_v3_sdk/api/transactional_sms_api.py | 8 +- sib_api_v3_sdk/api/webhooks_api.py | 10 +- sib_api_v3_sdk/configuration.py | 7 + sib_api_v3_sdk/models/create_attribute.py | 4 +- sib_api_v3_sdk/models/create_contact.py | 4 +- .../models/create_email_campaign.py | 205 ++++++++++++++++- sib_api_v3_sdk/models/create_smtp_template.py | 4 +- .../models/create_update_contact_model.py | 4 +- .../models/get_campaign_overview.py | 211 +++++++++++++++++- sib_api_v3_sdk/models/get_contact_details.py | 31 ++- sib_api_v3_sdk/models/get_email_campaign.py | 207 ++++++++++++++++- .../models/get_extended_campaign_overview.py | 207 ++++++++++++++++- .../models/get_extended_contact_details.py | 31 ++- .../models/request_contact_export.py | 4 +- sib_api_v3_sdk/models/send_email.py | 12 +- sib_api_v3_sdk/models/send_smtp_email.py | 16 +- sib_api_v3_sdk/models/update_attribute.py | 4 +- sib_api_v3_sdk/models/update_contact.py | 4 +- .../models/update_email_campaign.py | 196 +++++++++++++++- sib_api_v3_sdk/models/update_smtp_template.py | 4 +- 62 files changed, 1871 insertions(+), 303 deletions(-) diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 44004a9..6685483 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -25,6 +25,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)) @@ -46,7 +51,7 @@ This endpoint does not need any parameter. ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/AttributesApi.md b/docs/AttributesApi.md index c10e217..04e5329 100644 --- a/docs/AttributesApi.md +++ b/docs/AttributesApi.md @@ -28,6 +28,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.AttributesApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -56,7 +61,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -83,6 +88,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.AttributesApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -109,7 +119,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -136,6 +146,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.AttributesApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -157,7 +172,7 @@ This endpoint does not need any parameter. ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -184,6 +199,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.AttributesApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -212,7 +232,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index 42810f7..f1254a1 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -50,6 +50,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -77,7 +82,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -104,6 +109,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -132,7 +142,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -159,6 +169,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -184,7 +199,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -211,6 +226,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -236,7 +256,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -263,6 +283,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -288,7 +313,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -315,6 +340,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -341,7 +371,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -368,6 +398,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -392,7 +427,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -419,6 +454,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -443,7 +483,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -470,6 +510,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -494,7 +539,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -521,6 +566,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -542,7 +592,7 @@ This endpoint does not need any parameter. ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -569,6 +619,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -594,7 +649,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -621,6 +676,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -646,7 +706,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -673,6 +733,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -702,7 +767,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -729,6 +794,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -760,7 +830,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -787,6 +857,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -812,7 +887,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -839,6 +914,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -868,7 +948,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -895,6 +975,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -922,7 +1007,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -949,6 +1034,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -974,7 +1064,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1001,6 +1091,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1028,7 +1123,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1057,6 +1152,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1082,7 +1182,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1109,6 +1209,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1136,7 +1241,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1165,6 +1270,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1190,7 +1300,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1217,6 +1327,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1245,7 +1360,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1272,6 +1387,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1298,7 +1418,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1325,6 +1445,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1351,7 +1476,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -1378,6 +1503,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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -1404,7 +1534,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/CreateAttribute.md b/docs/CreateAttribute.md index 8cc6209..fcc16f2 100644 --- a/docs/CreateAttribute.md +++ b/docs/CreateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] -**enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] +**enumeration** | [**list[CreateAttributeEnumeration]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` | [optional] **type** | **str** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [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) diff --git a/docs/CreateContact.md b/docs/CreateContact.md index 6154533..fb3d570 100644 --- a/docs/CreateContact.md +++ b/docs/CreateContact.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | Email address of the user. Mandatory if \"sms\" field is not passed in \"attributes\" parameter' | [optional] -**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} | [optional] +**attributes** | **object** | Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` | [optional] **email_blacklisted** | **bool** | Set this field to blacklist the contact for emails (emailBlacklisted = true) | [optional] **sms_blacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional] **list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional] diff --git a/docs/CreateEmailCampaign.md b/docs/CreateEmailCampaign.md index f08e092..562cd77 100644 --- a/docs/CreateEmailCampaign.md +++ b/docs/CreateEmailCampaign.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **html_url** | **str** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional] **template_id** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional] **scheduled_at** | **datetime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] -**subject** | **str** | Subject of the campaign | +**subject** | **str** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional] **reply_to** | **str** | Email on which the campaign recipients will be able to reply to | [optional] -**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] +**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional] **recipients** | [**CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **inline_image_activation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to False] @@ -20,8 +20,14 @@ Name | Type | Description | Notes **footer** | **str** | Footer of the email campaign | [optional] **header** | **str** | Header of the email campaign | [optional] **utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] -**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] +**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. | [optional] [default to False] +**ab_testing** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to False] +**subject_a** | **str** | Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] +**subject_b** | **str** | Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value | [optional] +**split_rule** | **int** | Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] +**winner_criteria** | **str** | Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed | [optional] +**winner_delay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed | [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) diff --git a/docs/CreateSmtpTemplate.md b/docs/CreateSmtpTemplate.md index 929d8a4..d911ab3 100644 --- a/docs/CreateSmtpTemplate.md +++ b/docs/CreateSmtpTemplate.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **html_url** | **str** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] **subject** | **str** | Subject of the template | **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] -**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] +**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **is_active** | **bool** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] diff --git a/docs/CreateUpdateContactModel.md b/docs/CreateUpdateContactModel.md index 3a82011..d347a5f 100644 --- a/docs/CreateUpdateContactModel.md +++ b/docs/CreateUpdateContactModel.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | ID of the object created | [optional] +**id** | **int** | ID of the contact when a new contact is created | [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) diff --git a/docs/EmailCampaignsApi.md b/docs/EmailCampaignsApi.md index 792e8a6..9f919f4 100644 --- a/docs/EmailCampaignsApi.md +++ b/docs/EmailCampaignsApi.md @@ -34,6 +34,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -59,7 +64,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -86,6 +91,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -110,7 +120,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -137,6 +147,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -164,7 +179,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -191,6 +206,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -216,7 +236,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -243,6 +263,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -278,7 +303,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -305,6 +330,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -329,7 +359,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -358,6 +388,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -384,7 +419,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -411,6 +446,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -437,7 +477,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -464,6 +504,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -490,7 +535,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -517,6 +562,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.EmailCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -543,7 +593,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/FoldersApi.md b/docs/FoldersApi.md index 6e9cd4e..2fbcead 100644 --- a/docs/FoldersApi.md +++ b/docs/FoldersApi.md @@ -30,6 +30,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -55,7 +60,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -82,6 +87,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -106,7 +116,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -133,6 +143,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -158,7 +173,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -185,6 +200,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -214,7 +234,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -241,6 +261,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -268,7 +293,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -295,6 +320,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.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -321,7 +351,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/GetCampaignOverview.md b/docs/GetCampaignOverview.md index e57d237..a094ccf 100644 --- a/docs/GetCampaignOverview.md +++ b/docs/GetCampaignOverview.md @@ -5,10 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **str** | Name of the campaign | -**subject** | **str** | Subject of the campaign | +**subject** | **str** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **type** | **str** | Type of campaign | **status** | **str** | Status of the campaign | **scheduled_at** | **datetime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**ab_testing** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] +**subject_a** | **str** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**subject_b** | **str** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**split_rule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_criteria** | **str** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_delay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] +**send_at_best_time** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [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) diff --git a/docs/GetContactDetails.md b/docs/GetContactDetails.md index 6e49c68..51a1bd2 100644 --- a/docs/GetContactDetails.md +++ b/docs/GetContactDetails.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **id** | **int** | ID of the contact for which you requested the details | **email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | **sms_blacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | +**created_at** | **datetime** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modified_at** | **datetime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **list_ids** | **list[int]** | | **list_unsubscribed** | **list[int]** | | [optional] diff --git a/docs/GetEmailCampaign.md b/docs/GetEmailCampaign.md index a400557..85469a6 100644 --- a/docs/GetEmailCampaign.md +++ b/docs/GetEmailCampaign.md @@ -5,10 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **str** | Name of the campaign | -**subject** | **str** | Subject of the campaign | +**subject** | **str** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **type** | **str** | Type of campaign | **status** | **str** | Status of the campaign | **scheduled_at** | **datetime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**ab_testing** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] +**subject_a** | **str** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**subject_b** | **str** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**split_rule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_criteria** | **str** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_delay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] +**send_at_best_time** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] **test_sent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) | **header** | **str** | Header of the campaign | **footer** | **str** | Footer of the campaign | diff --git a/docs/GetExtendedCampaignOverview.md b/docs/GetExtendedCampaignOverview.md index 27abd8f..87ff5ca 100644 --- a/docs/GetExtendedCampaignOverview.md +++ b/docs/GetExtendedCampaignOverview.md @@ -5,10 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | ID of the campaign | **name** | **str** | Name of the campaign | -**subject** | **str** | Subject of the campaign | +**subject** | **str** | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | [optional] **type** | **str** | Type of campaign | **status** | **str** | Status of the campaign | **scheduled_at** | **datetime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**ab_testing** | **bool** | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. | [optional] +**subject_a** | **str** | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**subject_b** | **str** | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | [optional] +**split_rule** | **int** | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_criteria** | **str** | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | [optional] +**winner_delay** | **int** | The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` | [optional] +**send_at_best_time** | **bool** | It is true if you have chosen to send your campaign at best time, otherwise it is false | [optional] **test_sent** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) | **header** | **str** | Header of the campaign | **footer** | **str** | Footer of the campaign | diff --git a/docs/GetExtendedContactDetails.md b/docs/GetExtendedContactDetails.md index e5dbaa6..c00854a 100644 --- a/docs/GetExtendedContactDetails.md +++ b/docs/GetExtendedContactDetails.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **id** | **int** | ID of the contact for which you requested the details | **email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | **sms_blacklisted** | **bool** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | +**created_at** | **datetime** | Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **modified_at** | **datetime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) | **list_ids** | **list[int]** | | **list_unsubscribed** | **list[int]** | | [optional] diff --git a/docs/ListsApi.md b/docs/ListsApi.md index 670b56f..336448b 100644 --- a/docs/ListsApi.md +++ b/docs/ListsApi.md @@ -33,6 +33,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -60,7 +65,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -87,6 +92,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -112,7 +122,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -139,6 +149,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -163,7 +178,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -190,6 +205,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -221,7 +241,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -248,6 +268,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -277,7 +302,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -304,6 +329,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -329,7 +359,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -356,6 +386,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -383,7 +418,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -410,6 +445,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -437,7 +477,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -464,6 +504,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.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -490,7 +535,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/ProcessApi.md b/docs/ProcessApi.md index 7c657cd..eb91297 100644 --- a/docs/ProcessApi.md +++ b/docs/ProcessApi.md @@ -26,6 +26,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.ProcessApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -51,7 +56,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -78,6 +83,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.ProcessApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -105,7 +115,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/RequestContactExport.md b/docs/RequestContactExport.md index a13b7c7..f9789ca 100644 --- a/docs/RequestContactExport.md +++ b/docs/RequestContactExport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **export_attributes** | **list[str]** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] -**contact_filter** | **object** | Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. | +**contact_filter** | **object** | Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts. | **notify_url** | **str** | Webhook that will be called once the export process is finished | [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) diff --git a/docs/ResellerApi.md b/docs/ResellerApi.md index 13cb29f..9d4ddb8 100644 --- a/docs/ResellerApi.md +++ b/docs/ResellerApi.md @@ -33,6 +33,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -60,7 +65,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -87,6 +92,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -113,7 +123,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -140,6 +150,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -165,7 +180,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -192,6 +207,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -216,7 +236,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -243,6 +263,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -269,7 +294,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -296,6 +321,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -321,7 +351,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -348,6 +378,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -369,7 +404,7 @@ This endpoint does not need any parameter. ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -396,6 +431,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -423,7 +463,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -450,6 +490,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.ResellerApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -476,7 +521,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md index 32da91b..0d23d6f 100644 --- a/docs/SMSCampaignsApi.md +++ b/docs/SMSCampaignsApi.md @@ -34,6 +34,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -59,7 +64,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -86,6 +91,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -110,7 +120,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -137,6 +147,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -164,7 +179,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -191,6 +206,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -224,7 +244,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -253,6 +273,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -280,7 +305,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -307,6 +332,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -331,7 +361,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -360,6 +390,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -386,7 +421,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -413,6 +448,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -439,7 +479,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -466,6 +506,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -492,7 +537,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -519,6 +564,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.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -545,7 +595,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/SMTPApi.md b/docs/SMTPApi.md index 92ea75b..6d180c1 100644 --- a/docs/SMTPApi.md +++ b/docs/SMTPApi.md @@ -36,6 +36,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -61,7 +66,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -90,6 +95,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -114,7 +124,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -141,6 +151,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -165,7 +180,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -192,6 +207,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -223,7 +243,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -250,6 +270,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -293,7 +318,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -320,6 +345,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -355,7 +385,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -382,6 +412,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -407,7 +442,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -434,6 +469,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -463,7 +503,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -492,6 +532,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -519,7 +564,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -546,6 +591,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -572,7 +622,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -599,6 +649,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -624,7 +679,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -651,6 +706,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.SMTPApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -677,7 +737,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/SendEmail.md b/docs/SendEmail.md index 8ddaade..ea86fdd 100644 --- a/docs/SendEmail.md +++ b/docs/SendEmail.md @@ -8,9 +8,9 @@ Name | Type | Description | Notes **email_cc** | **list[str]** | List of the email addresses of the recipients in cc | [optional] **reply_to** | **str** | Email address which shall be used by campaign recipients to reply back | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] -**attachment** | [**list[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. | [optional] -**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] -**attributes** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} | [optional] +**attachment** | [**list[SendEmailAttachment]**](SendEmailAttachment.md) | Pass the list of content (base64 encoded) and name of the attachment. For example, `[{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]` | [optional] +**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` | [optional] +**attributes** | **object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} | [optional] **tags** | **list[str]** | Tag your emails to find them more easily | [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) diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 974ae38..925ea3e 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -4,17 +4,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sender** | [**SendSmtpEmailSender**](SendSmtpEmailSender.md) | | [optional] -**to** | [**list[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] | +**to** | [**list[SendSmtpEmailTo]**](SendSmtpEmailTo.md) | List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]` | **bcc** | [**list[SendSmtpEmailBcc]**](SendSmtpEmailBcc.md) | List of email addresses and names (optional) of the recipients in bcc | [optional] **cc** | [**list[SendSmtpEmailCc]**](SendSmtpEmailCc.md) | List of email addresses and names (optional) of the recipients in cc | [optional] **html_content** | **str** | HTML body of the message ( Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed ) | [optional] **text_content** | **str** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] **subject** | **str** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] -**attachment** | [**list[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( Ignored if 'templateId' is passed ) | [optional] -**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} | [optional] +**attachment** | [**list[SendSmtpEmailAttachment]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] +**headers** | **object** | Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` | [optional] **template_id** | **int** | Id of the template | [optional] -**params** | **object** | Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. | [optional] +**params** | **object** | Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format. | [optional] **tags** | **list[str]** | Tag your emails to find them more easily | [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) diff --git a/docs/SendersApi.md b/docs/SendersApi.md index c9d50e6..02b5ad4 100644 --- a/docs/SendersApi.md +++ b/docs/SendersApi.md @@ -30,6 +30,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -55,7 +60,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -82,6 +87,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -106,7 +116,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -133,6 +143,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -154,7 +169,7 @@ This endpoint does not need any parameter. ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -181,6 +196,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -206,7 +226,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -233,6 +253,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -260,7 +285,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -287,6 +312,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.SendersApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -313,7 +343,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index 60663da..f5751ee 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -28,6 +28,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.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -67,7 +72,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -94,6 +99,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.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -125,7 +135,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -152,6 +162,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.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -183,7 +198,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -210,6 +225,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.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -235,7 +255,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/docs/UpdateAttribute.md b/docs/UpdateAttribute.md index b1efb93..2f2c31f 100644 --- a/docs/UpdateAttribute.md +++ b/docs/UpdateAttribute.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global' | [optional] -**enumeration** | [**list[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] +**enumeration** | [**list[UpdateAttributeEnumeration]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` | [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) diff --git a/docs/UpdateContact.md b/docs/UpdateContact.md index 678967d..b5512ff 100644 --- a/docs/UpdateContact.md +++ b/docs/UpdateContact.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} | [optional] +**attributes** | **object** | Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}` | [optional] **email_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) | [optional] **sms_blacklisted** | **bool** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] **list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional] diff --git a/docs/UpdateEmailCampaign.md b/docs/UpdateEmailCampaign.md index 79ba317..739296f 100644 --- a/docs/UpdateEmailCampaign.md +++ b/docs/UpdateEmailCampaign.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **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. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional] **subject** | **str** | Subject of the campaign | [optional] **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] -**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] +**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional] **recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **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. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to False] @@ -20,8 +20,14 @@ Name | Type | Description | Notes **footer** | **str** | Footer of the email campaign | [optional] **header** | **str** | Header of the email campaign | [optional] **utm_campaign** | **str** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] -**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] +**params** | **object** | Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [optional] **send_at_best_time** | **bool** | Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled. | [optional] +**ab_testing** | **bool** | Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B | [optional] [default to False] +**subject_a** | **str** | Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] +**subject_b** | **str** | Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value | [optional] +**split_rule** | **int** | Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else | [optional] +**winner_criteria** | **str** | Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record | [optional] +**winner_delay** | **int** | Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record | [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) diff --git a/docs/UpdateSmtpTemplate.md b/docs/UpdateSmtpTemplate.md index d9598d8..3a334f0 100644 --- a/docs/UpdateSmtpTemplate.md +++ b/docs/UpdateSmtpTemplate.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **html_url** | **str** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] **subject** | **str** | Subject of the email | [optional] **reply_to** | **str** | Email on which campaign recipients will be able to reply to | [optional] -**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization | [optional] +**to_field** | **str** | To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization | [optional] **attachment_url** | **str** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **is_active** | **bool** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index f92f74e..3ee0e73 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -29,6 +29,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.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -54,7 +59,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -81,6 +86,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.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -105,7 +115,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -132,6 +142,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.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -157,7 +172,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -184,6 +199,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.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -209,7 +229,7 @@ Name | Type | Description | Notes ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers @@ -236,6 +256,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.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration)) @@ -262,7 +287,7 @@ void (empty response body) ### Authorization -[api-key](../README.md#api-key) +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) ### HTTP request headers diff --git a/setup.py b/setup.py index 4ad88e2..7246af6 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ from setuptools import setup, find_packages NAME = "sib-api-v3-sdk" -VERSION = "4.2.0" +VERSION = "4.2.1" # To install the library, run the following # # python setup.py install diff --git a/sib_api_v3_sdk/api/account_api.py b/sib_api_v3_sdk/api/account_api.py index b180cce..98811bd 100644 --- a/sib_api_v3_sdk/api/account_api.py +++ b/sib_api_v3_sdk/api/account_api.py @@ -104,7 +104,7 @@ def get_account_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/account', 'GET', diff --git a/sib_api_v3_sdk/api/attributes_api.py b/sib_api_v3_sdk/api/attributes_api.py index 16b671d..f8505a5 100644 --- a/sib_api_v3_sdk/api/attributes_api.py +++ b/sib_api_v3_sdk/api/attributes_api.py @@ -128,7 +128,7 @@ def create_attribute_with_http_info(self, attribute_category, attribute_name, cr ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'POST', @@ -233,7 +233,7 @@ def delete_attribute_with_http_info(self, attribute_category, attribute_name, ** ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'DELETE', @@ -322,7 +322,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes', 'GET', @@ -435,7 +435,7 @@ def update_attribute_with_http_info(self, attribute_category, attribute_name, up ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'PUT', diff --git a/sib_api_v3_sdk/api/contacts_api.py b/sib_api_v3_sdk/api/contacts_api.py index 9aec2b0..ddd4ddd 100644 --- a/sib_api_v3_sdk/api/contacts_api.py +++ b/sib_api_v3_sdk/api/contacts_api.py @@ -120,7 +120,7 @@ def add_contact_to_list_with_http_info(self, list_id, contact_emails, **kwargs): ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/add', 'POST', @@ -233,7 +233,7 @@ def create_attribute_with_http_info(self, attribute_category, attribute_name, cr ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'POST', @@ -330,7 +330,7 @@ def create_contact_with_http_info(self, create_contact, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts', 'POST', @@ -427,7 +427,7 @@ def create_folder_with_http_info(self, create_folder, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', 'POST', @@ -524,7 +524,7 @@ def create_list_with_http_info(self, create_list, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', 'POST', @@ -629,7 +629,7 @@ def delete_attribute_with_http_info(self, attribute_category, attribute_name, ** ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'DELETE', @@ -726,7 +726,7 @@ def delete_contact_with_http_info(self, email, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{email}', 'DELETE', @@ -823,7 +823,7 @@ def delete_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'DELETE', @@ -920,7 +920,7 @@ def delete_list_with_http_info(self, list_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'DELETE', @@ -1009,7 +1009,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes', 'GET', @@ -1106,7 +1106,7 @@ def get_contact_info_with_http_info(self, email, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{email}', 'GET', @@ -1203,7 +1203,7 @@ def get_contact_stats_with_http_info(self, email, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{email}/campaignStats', 'GET', @@ -1306,7 +1306,7 @@ def get_contacts_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts', 'GET', @@ -1417,7 +1417,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts', 'GET', @@ -1514,7 +1514,7 @@ def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'GET', @@ -1621,7 +1621,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}/lists', 'GET', @@ -1728,7 +1728,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', 'GET', @@ -1825,7 +1825,7 @@ def get_list_with_http_info(self, list_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'GET', @@ -1924,7 +1924,7 @@ def get_lists_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', 'GET', @@ -2023,7 +2023,7 @@ def import_contacts_with_http_info(self, request_contact_import, **kwargs): # n ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/import', 'POST', @@ -2128,7 +2128,7 @@ def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwa ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/remove', 'POST', @@ -2227,7 +2227,7 @@ def request_contact_export_with_http_info(self, request_contact_export, **kwargs ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/export', 'POST', @@ -2340,7 +2340,7 @@ def update_attribute_with_http_info(self, attribute_category, attribute_name, up ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/attributes/{attributeCategory}/{attributeName}', 'PUT', @@ -2445,7 +2445,7 @@ def update_contact_with_http_info(self, email, update_contact, **kwargs): # noq ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/{email}', 'PUT', @@ -2550,7 +2550,7 @@ def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # n ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'PUT', @@ -2655,7 +2655,7 @@ def update_list_with_http_info(self, list_id, update_list, **kwargs): # noqa: E ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'PUT', diff --git a/sib_api_v3_sdk/api/email_campaigns_api.py b/sib_api_v3_sdk/api/email_campaigns_api.py index 4e076b5..344c023 100644 --- a/sib_api_v3_sdk/api/email_campaigns_api.py +++ b/sib_api_v3_sdk/api/email_campaigns_api.py @@ -112,7 +112,7 @@ def create_email_campaign_with_http_info(self, email_campaigns, **kwargs): # no ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns', 'POST', @@ -209,7 +209,7 @@ def delete_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'DELETE', @@ -310,7 +310,7 @@ def email_export_recipients_with_http_info(self, campaign_id, **kwargs): # noqa ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/exportRecipients', 'POST', @@ -407,7 +407,7 @@ def get_email_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E50 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'GET', @@ -522,7 +522,7 @@ def get_email_campaigns_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns', 'GET', @@ -619,7 +619,7 @@ def send_email_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sendNow', 'POST', @@ -726,7 +726,7 @@ def send_report_with_http_info(self, campaign_id, send_report, **kwargs): # noq ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sendReport', 'POST', @@ -831,7 +831,7 @@ def send_test_email_with_http_info(self, campaign_id, email_to, **kwargs): # no ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/sendTest', 'POST', @@ -936,7 +936,7 @@ def update_campaign_status_with_http_info(self, campaign_id, status, **kwargs): ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}/status', 'PUT', @@ -1041,7 +1041,7 @@ def update_email_campaign_with_http_info(self, campaign_id, email_campaign, **kw ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/emailCampaigns/{campaignId}', 'PUT', diff --git a/sib_api_v3_sdk/api/folders_api.py b/sib_api_v3_sdk/api/folders_api.py index de78622..cd5147e 100644 --- a/sib_api_v3_sdk/api/folders_api.py +++ b/sib_api_v3_sdk/api/folders_api.py @@ -112,7 +112,7 @@ def create_folder_with_http_info(self, create_folder, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', 'POST', @@ -209,7 +209,7 @@ def delete_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'DELETE', @@ -306,7 +306,7 @@ def get_folder_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'GET', @@ -413,7 +413,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}/lists', 'GET', @@ -520,7 +520,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders', 'GET', @@ -625,7 +625,7 @@ def update_folder_with_http_info(self, folder_id, update_folder, **kwargs): # n ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}', 'PUT', diff --git a/sib_api_v3_sdk/api/lists_api.py b/sib_api_v3_sdk/api/lists_api.py index 6d22d54..7199cb1 100644 --- a/sib_api_v3_sdk/api/lists_api.py +++ b/sib_api_v3_sdk/api/lists_api.py @@ -120,7 +120,7 @@ def add_contact_to_list_with_http_info(self, list_id, contact_emails, **kwargs): ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/add', 'POST', @@ -217,7 +217,7 @@ def create_list_with_http_info(self, create_list, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', 'POST', @@ -314,7 +314,7 @@ def delete_list_with_http_info(self, list_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'DELETE', @@ -425,7 +425,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts', 'GET', @@ -532,7 +532,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/folders/{folderId}/lists', 'GET', @@ -629,7 +629,7 @@ def get_list_with_http_info(self, list_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'GET', @@ -728,7 +728,7 @@ def get_lists_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists', 'GET', @@ -833,7 +833,7 @@ def remove_contact_from_list_with_http_info(self, list_id, contact_emails, **kwa ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}/contacts/remove', 'POST', @@ -938,7 +938,7 @@ def update_list_with_http_info(self, list_id, update_list, **kwargs): # noqa: E ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/contacts/lists/{listId}', 'PUT', diff --git a/sib_api_v3_sdk/api/process_api.py b/sib_api_v3_sdk/api/process_api.py index 3cfdd4c..0026114 100644 --- a/sib_api_v3_sdk/api/process_api.py +++ b/sib_api_v3_sdk/api/process_api.py @@ -112,7 +112,7 @@ def get_process_with_http_info(self, process_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/processes/{processId}', 'GET', @@ -211,7 +211,7 @@ def get_processes_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/processes', 'GET', diff --git a/sib_api_v3_sdk/api/reseller_api.py b/sib_api_v3_sdk/api/reseller_api.py index cccd415..fe75727 100644 --- a/sib_api_v3_sdk/api/reseller_api.py +++ b/sib_api_v3_sdk/api/reseller_api.py @@ -120,7 +120,7 @@ def add_credits_with_http_info(self, child_auth_key, add_credits, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}/credits/add', 'POST', @@ -225,7 +225,7 @@ def associate_ip_to_child_with_http_info(self, child_auth_key, ip, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}/ips/associate', 'POST', @@ -318,7 +318,7 @@ def create_reseller_child_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children', 'POST', @@ -415,7 +415,7 @@ def delete_reseller_child_with_http_info(self, child_auth_key, **kwargs): # noq ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}', 'DELETE', @@ -520,7 +520,7 @@ def dissociate_ip_from_child_with_http_info(self, child_auth_key, ip, **kwargs): ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}/ips/dissociate', 'POST', @@ -617,7 +617,7 @@ def get_child_info_with_http_info(self, child_auth_key, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}', 'GET', @@ -706,7 +706,7 @@ def get_reseller_childs_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children', 'GET', @@ -811,7 +811,7 @@ def remove_credits_with_http_info(self, child_auth_key, remove_credits, **kwargs ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}/credits/remove', 'POST', @@ -916,7 +916,7 @@ def update_reseller_child_with_http_info(self, child_auth_key, reseller_child, * ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/reseller/children/{childAuthKey}', 'PUT', diff --git a/sib_api_v3_sdk/api/senders_api.py b/sib_api_v3_sdk/api/senders_api.py index 64efd1d..59472be 100644 --- a/sib_api_v3_sdk/api/senders_api.py +++ b/sib_api_v3_sdk/api/senders_api.py @@ -108,7 +108,7 @@ def create_sender_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders', 'POST', @@ -205,7 +205,7 @@ def delete_sender_with_http_info(self, sender_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders/{senderId}', 'DELETE', @@ -294,7 +294,7 @@ def get_ips_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders/ips', 'GET', @@ -391,7 +391,7 @@ def get_ips_from_sender_with_http_info(self, sender_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders/{senderId}/ips', 'GET', @@ -488,7 +488,7 @@ def get_senders_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders', 'GET', @@ -589,7 +589,7 @@ def update_sender_with_http_info(self, sender_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/senders/{senderId}', 'PUT', diff --git a/sib_api_v3_sdk/api/sms_campaigns_api.py b/sib_api_v3_sdk/api/sms_campaigns_api.py index 5896c69..0eb0ec0 100644 --- a/sib_api_v3_sdk/api/sms_campaigns_api.py +++ b/sib_api_v3_sdk/api/sms_campaigns_api.py @@ -112,7 +112,7 @@ def create_sms_campaign_with_http_info(self, create_sms_campaign, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns', 'POST', @@ -209,7 +209,7 @@ def delete_sms_campaign_with_http_info(self, campaign_id, **kwargs): # noqa: E5 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}', 'DELETE', @@ -314,7 +314,7 @@ def get_sms_campaign_with_http_info(self, campaign_id, get_sms_campaign, **kwarg ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}', 'GET', @@ -425,7 +425,7 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns', 'GET', @@ -528,7 +528,7 @@ def request_sms_recipient_export_with_http_info(self, campaign_id, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}/exportRecipients', 'POST', @@ -625,7 +625,7 @@ def send_sms_campaign_now_with_http_info(self, campaign_id, **kwargs): # noqa: ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}/sendNow', 'POST', @@ -732,7 +732,7 @@ def send_sms_report_with_http_info(self, campaign_id, send_report, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}/sendReport', 'POST', @@ -837,7 +837,7 @@ def send_test_sms_with_http_info(self, campaign_id, phone_number, **kwargs): # ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}/sendTest', 'POST', @@ -942,7 +942,7 @@ def update_sms_campaign_with_http_info(self, campaign_id, update_sms_campaign, * ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}', 'PUT', @@ -1047,7 +1047,7 @@ def update_sms_campaign_status_with_http_info(self, campaign_id, status, **kwarg ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smsCampaigns/{campaignId}/status', 'PUT', diff --git a/sib_api_v3_sdk/api/smtp_api.py b/sib_api_v3_sdk/api/smtp_api.py index ea514fa..c06fd1d 100644 --- a/sib_api_v3_sdk/api/smtp_api.py +++ b/sib_api_v3_sdk/api/smtp_api.py @@ -112,7 +112,7 @@ def create_smtp_template_with_http_info(self, smtp_template, **kwargs): # noqa: ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates', 'POST', @@ -207,7 +207,7 @@ def delete_hardbounces_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/deleteHardbounces', 'POST', @@ -304,7 +304,7 @@ def delete_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates/{templateId}', 'DELETE', @@ -409,7 +409,7 @@ def get_aggregated_smtp_report_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/statistics/aggregatedReport', 'GET', @@ -540,7 +540,7 @@ def get_email_event_report_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/statistics/events', 'GET', @@ -655,7 +655,7 @@ def get_smtp_report_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/statistics/reports', 'GET', @@ -752,7 +752,7 @@ def get_smtp_template_with_http_info(self, template_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates/{templateId}', 'GET', @@ -855,7 +855,7 @@ def get_smtp_templates_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates', 'GET', @@ -962,7 +962,7 @@ def send_template_with_http_info(self, template_id, send_email, **kwargs): # no ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates/{templateId}/send', 'POST', @@ -1067,7 +1067,7 @@ def send_test_template_with_http_info(self, template_id, send_test_email, **kwar ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates/{templateId}/sendTest', 'POST', @@ -1164,7 +1164,7 @@ def send_transac_email_with_http_info(self, send_smtp_email, **kwargs): # noqa: ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/email', 'POST', @@ -1269,7 +1269,7 @@ def update_smtp_template_with_http_info(self, template_id, smtp_template, **kwar ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/smtp/templates/{templateId}', 'PUT', diff --git a/sib_api_v3_sdk/api/transactional_sms_api.py b/sib_api_v3_sdk/api/transactional_sms_api.py index 1eb5e90..7b6dd24 100644 --- a/sib_api_v3_sdk/api/transactional_sms_api.py +++ b/sib_api_v3_sdk/api/transactional_sms_api.py @@ -138,7 +138,7 @@ def get_sms_events_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/transactionalSMS/statistics/events', 'GET', @@ -243,7 +243,7 @@ def get_transac_aggregated_sms_report_with_http_info(self, **kwargs): # noqa: E ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/transactionalSMS/statistics/aggregatedReport', 'GET', @@ -348,7 +348,7 @@ def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/transactionalSMS/statistics/reports', 'GET', @@ -445,7 +445,7 @@ def send_transac_sms_with_http_info(self, send_transac_sms, **kwargs): # noqa: ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/transactionalSMS/sms', 'POST', diff --git a/sib_api_v3_sdk/api/webhooks_api.py b/sib_api_v3_sdk/api/webhooks_api.py index 8faf27d..d810f21 100644 --- a/sib_api_v3_sdk/api/webhooks_api.py +++ b/sib_api_v3_sdk/api/webhooks_api.py @@ -112,7 +112,7 @@ def create_webhook_with_http_info(self, create_webhook, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/webhooks', 'POST', @@ -209,7 +209,7 @@ def delete_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', 'DELETE', @@ -306,7 +306,7 @@ def get_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', 'GET', @@ -399,7 +399,7 @@ def get_webhooks_with_http_info(self, **kwargs): # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/webhooks', 'GET', @@ -504,7 +504,7 @@ def update_webhook_with_http_info(self, webhook_id, update_webhook, **kwargs): ['application/json']) # noqa: E501 # Authentication setting - auth_settings = ['api-key'] # noqa: E501 + auth_settings = ['api-key', 'partner-key'] # noqa: E501 return self.api_client.call_api( '/webhooks/{webhookId}', 'PUT', diff --git a/sib_api_v3_sdk/configuration.py b/sib_api_v3_sdk/configuration.py index 9ed6ad1..a831a95 100644 --- a/sib_api_v3_sdk/configuration.py +++ b/sib_api_v3_sdk/configuration.py @@ -231,6 +231,13 @@ def auth_settings(self): 'key': 'api-key', 'value': self.get_api_key_with_prefix('api-key') }, + 'partner-key': + { + 'type': 'api_key', + 'in': 'header', + 'key': 'partner-key', + 'value': self.get_api_key_with_prefix('partner-key') + }, } diff --git a/sib_api_v3_sdk/models/create_attribute.py b/sib_api_v3_sdk/models/create_attribute.py index 591653e..036d41f 100644 --- a/sib_api_v3_sdk/models/create_attribute.py +++ b/sib_api_v3_sdk/models/create_attribute.py @@ -86,7 +86,7 @@ def value(self, value): def enumeration(self): """Gets the enumeration of this CreateAttribute. # noqa: E501 - List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` # noqa: E501 :return: The enumeration of this CreateAttribute. # noqa: E501 :rtype: list[CreateAttributeEnumeration] @@ -97,7 +97,7 @@ def enumeration(self): def enumeration(self, enumeration): """Sets the enumeration of this CreateAttribute. - List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` # noqa: E501 :param enumeration: The enumeration of this CreateAttribute. # noqa: E501 :type: list[CreateAttributeEnumeration] diff --git a/sib_api_v3_sdk/models/create_contact.py b/sib_api_v3_sdk/models/create_contact.py index cb0d5f5..4d34690 100644 --- a/sib_api_v3_sdk/models/create_contact.py +++ b/sib_api_v3_sdk/models/create_contact.py @@ -104,7 +104,7 @@ def email(self, email): def attributes(self): """Gets the attributes of this CreateContact. # noqa: E501 - Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} # noqa: E501 + Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` # noqa: E501 :return: The attributes of this CreateContact. # noqa: E501 :rtype: object @@ -115,7 +115,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this CreateContact. - Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'} # noqa: E501 + Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For example, `{\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"}` # noqa: E501 :param attributes: The attributes of this CreateContact. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/create_email_campaign.py b/sib_api_v3_sdk/models/create_email_campaign.py index 25d68b3..84e1828 100644 --- a/sib_api_v3_sdk/models/create_email_campaign.py +++ b/sib_api_v3_sdk/models/create_email_campaign.py @@ -52,7 +52,13 @@ class CreateEmailCampaign(object): 'header': 'str', 'utm_campaign': 'str', 'params': 'object', - 'send_at_best_time': 'bool' + 'send_at_best_time': 'bool', + 'ab_testing': 'bool', + 'subject_a': 'str', + 'subject_b': 'str', + 'split_rule': 'int', + 'winner_criteria': 'str', + 'winner_delay': 'int' } attribute_map = { @@ -74,10 +80,16 @@ class CreateEmailCampaign(object): 'header': 'header', 'utm_campaign': 'utmCampaign', 'params': 'params', - 'send_at_best_time': 'sendAtBestTime' + 'send_at_best_time': 'sendAtBestTime', + 'ab_testing': 'abTesting', + 'subject_a': 'subjectA', + 'subject_b': 'subjectB', + 'split_rule': 'splitRule', + 'winner_criteria': 'winnerCriteria', + 'winner_delay': 'winnerDelay' } - def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False): # noqa: E501 + def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, template_id=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=False, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None): # noqa: E501 """CreateEmailCampaign - a model defined in Swagger""" # noqa: E501 self._tag = None @@ -99,6 +111,12 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url self._utm_campaign = None self._params = None self._send_at_best_time = None + self._ab_testing = None + self._subject_a = None + self._subject_b = None + self._split_rule = None + self._winner_criteria = None + self._winner_delay = None self.discriminator = None if tag is not None: @@ -113,7 +131,8 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url self.template_id = template_id if scheduled_at is not None: self.scheduled_at = scheduled_at - self.subject = subject + if subject is not None: + self.subject = subject if reply_to is not None: self.reply_to = reply_to if to_field is not None: @@ -136,6 +155,18 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url self.params = params if send_at_best_time is not None: self.send_at_best_time = send_at_best_time + if ab_testing is not None: + self.ab_testing = ab_testing + if subject_a is not None: + self.subject_a = subject_a + if subject_b is not None: + self.subject_b = subject_b + if split_rule is not None: + self.split_rule = split_rule + if winner_criteria is not None: + self.winner_criteria = winner_criteria + if winner_delay is not None: + self.winner_delay = winner_delay @property def tag(self): @@ -304,7 +335,7 @@ def scheduled_at(self, scheduled_at): def subject(self): """Gets the subject of this CreateEmailCampaign. # noqa: E501 - Subject of the campaign # noqa: E501 + Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. # noqa: E501 :return: The subject of this CreateEmailCampaign. # noqa: E501 :rtype: str @@ -315,13 +346,11 @@ def subject(self): def subject(self, subject): """Sets the subject of this CreateEmailCampaign. - Subject of the campaign # noqa: E501 + Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. # noqa: E501 :param subject: The subject of this CreateEmailCampaign. # noqa: E501 :type: str """ - if subject is None: - raise ValueError("Invalid value for `subject`, must not be `None`") # noqa: E501 self._subject = subject @@ -352,7 +381,7 @@ def reply_to(self, reply_to): def to_field(self): """Gets the to_field of this CreateEmailCampaign. # noqa: E501 - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :return: The to_field of this CreateEmailCampaign. # noqa: E501 :rtype: str @@ -363,7 +392,7 @@ def to_field(self): def to_field(self, to_field): """Sets the to_field of this CreateEmailCampaign. - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :param to_field: The to_field of this CreateEmailCampaign. # noqa: E501 :type: str @@ -534,7 +563,7 @@ def utm_campaign(self, utm_campaign): def params(self): """Gets the params of this CreateEmailCampaign. # noqa: E501 - Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :return: The params of this CreateEmailCampaign. # noqa: E501 :rtype: object @@ -545,7 +574,7 @@ def params(self): def params(self, params): """Sets the params of this CreateEmailCampaign. - Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type classic campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME:\"Doe\"}`. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :param params: The params of this CreateEmailCampaign. # noqa: E501 :type: object @@ -576,6 +605,158 @@ def send_at_best_time(self, send_at_best_time): self._send_at_best_time = send_at_best_time + @property + def ab_testing(self): + """Gets the ab_testing of this CreateEmailCampaign. # noqa: E501 + + Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501 + + :return: The ab_testing of this CreateEmailCampaign. # noqa: E501 + :rtype: bool + """ + return self._ab_testing + + @ab_testing.setter + def ab_testing(self, ab_testing): + """Sets the ab_testing of this CreateEmailCampaign. + + Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501 + + :param ab_testing: The ab_testing of this CreateEmailCampaign. # noqa: E501 + :type: bool + """ + + self._ab_testing = ab_testing + + @property + def subject_a(self): + """Gets the subject_a of this CreateEmailCampaign. # noqa: E501 + + Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :return: The subject_a of this CreateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_a + + @subject_a.setter + def subject_a(self, subject_a): + """Sets the subject_a of this CreateEmailCampaign. + + Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :param subject_a: The subject_a of this CreateEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_a = subject_a + + @property + def subject_b(self): + """Gets the subject_b of this CreateEmailCampaign. # noqa: E501 + + Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :return: The subject_b of this CreateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_b + + @subject_b.setter + def subject_b(self, subject_b): + """Sets the subject_b of this CreateEmailCampaign. + + Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :param subject_b: The subject_b of this CreateEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_b = subject_b + + @property + def split_rule(self): + """Gets the split_rule of this CreateEmailCampaign. # noqa: E501 + + Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501 + + :return: The split_rule of this CreateEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._split_rule + + @split_rule.setter + def split_rule(self, split_rule): + """Sets the split_rule of this CreateEmailCampaign. + + Add the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501 + + :param split_rule: The split_rule of this CreateEmailCampaign. # noqa: E501 + :type: int + """ + if split_rule is not None and split_rule > 50: # noqa: E501 + raise ValueError("Invalid value for `split_rule`, must be a value less than or equal to `50`") # noqa: E501 + if split_rule is not None and split_rule < 1: # noqa: E501 + raise ValueError("Invalid value for `split_rule`, must be a value greater than or equal to `1`") # noqa: E501 + + self._split_rule = split_rule + + @property + def winner_criteria(self): + """Gets the winner_criteria of this CreateEmailCampaign. # noqa: E501 + + Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed # noqa: E501 + + :return: The winner_criteria of this CreateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._winner_criteria + + @winner_criteria.setter + def winner_criteria(self, winner_criteria): + """Sets the winner_criteria of this CreateEmailCampaign. + + Choose the metrics that will determinate the winning version. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed # noqa: E501 + + :param winner_criteria: The winner_criteria of this CreateEmailCampaign. # noqa: E501 + :type: str + """ + allowed_values = ["open", "click"] # noqa: E501 + if winner_criteria not in allowed_values: + raise ValueError( + "Invalid value for `winner_criteria` ({0}), must be one of {1}" # noqa: E501 + .format(winner_criteria, allowed_values) + ) + + self._winner_criteria = winner_criteria + + @property + def winner_delay(self): + """Gets the winner_delay of this CreateEmailCampaign. # noqa: E501 + + Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed # noqa: E501 + + :return: The winner_delay of this CreateEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._winner_delay + + @winner_delay.setter + def winner_delay(self, winner_delay): + """Sets the winner_delay of this CreateEmailCampaign. + + Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed # noqa: E501 + + :param winner_delay: The winner_delay of this CreateEmailCampaign. # noqa: E501 + :type: int + """ + if winner_delay is not None and winner_delay > 168: # noqa: E501 + raise ValueError("Invalid value for `winner_delay`, must be a value less than or equal to `168`") # noqa: E501 + if winner_delay is not None and winner_delay < 1: # noqa: E501 + raise ValueError("Invalid value for `winner_delay`, must be a value greater than or equal to `1`") # noqa: E501 + + self._winner_delay = winner_delay + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/create_smtp_template.py b/sib_api_v3_sdk/models/create_smtp_template.py index 3ab2bb2..98e991f 100644 --- a/sib_api_v3_sdk/models/create_smtp_template.py +++ b/sib_api_v3_sdk/models/create_smtp_template.py @@ -260,7 +260,7 @@ def reply_to(self, reply_to): def to_field(self): """Gets the to_field of this CreateSmtpTemplate. # noqa: E501 - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :return: The to_field of this CreateSmtpTemplate. # noqa: E501 :rtype: str @@ -271,7 +271,7 @@ def to_field(self): def to_field(self, to_field): """Sets the to_field of this CreateSmtpTemplate. - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :param to_field: The to_field of this CreateSmtpTemplate. # noqa: E501 :type: str diff --git a/sib_api_v3_sdk/models/create_update_contact_model.py b/sib_api_v3_sdk/models/create_update_contact_model.py index adcf771..5651f7f 100644 --- a/sib_api_v3_sdk/models/create_update_contact_model.py +++ b/sib_api_v3_sdk/models/create_update_contact_model.py @@ -51,7 +51,7 @@ def __init__(self, id=None): # noqa: E501 def id(self): """Gets the id of this CreateUpdateContactModel. # noqa: E501 - ID of the object created # noqa: E501 + ID of the contact when a new contact is created # noqa: E501 :return: The id of this CreateUpdateContactModel. # noqa: E501 :rtype: int @@ -62,7 +62,7 @@ def id(self): def id(self, id): """Sets the id of this CreateUpdateContactModel. - ID of the object created # noqa: E501 + ID of the contact when a new contact is created # noqa: E501 :param id: The id of this CreateUpdateContactModel. # noqa: E501 :type: int diff --git a/sib_api_v3_sdk/models/get_campaign_overview.py b/sib_api_v3_sdk/models/get_campaign_overview.py index 22d2dc9..7c9c2aa 100644 --- a/sib_api_v3_sdk/models/get_campaign_overview.py +++ b/sib_api_v3_sdk/models/get_campaign_overview.py @@ -36,7 +36,14 @@ class GetCampaignOverview(object): 'subject': 'str', 'type': 'str', 'status': 'str', - 'scheduled_at': 'datetime' + 'scheduled_at': 'datetime', + 'ab_testing': 'bool', + 'subject_a': 'str', + 'subject_b': 'str', + 'split_rule': 'int', + 'winner_criteria': 'str', + 'winner_delay': 'int', + 'send_at_best_time': 'bool' } attribute_map = { @@ -45,10 +52,17 @@ class GetCampaignOverview(object): 'subject': 'subject', 'type': 'type', 'status': 'status', - 'scheduled_at': 'scheduledAt' + 'scheduled_at': 'scheduledAt', + 'ab_testing': 'abTesting', + 'subject_a': 'subjectA', + 'subject_b': 'subjectB', + 'split_rule': 'splitRule', + 'winner_criteria': 'winnerCriteria', + 'winner_delay': 'winnerDelay', + 'send_at_best_time': 'sendAtBestTime' } - def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None): # noqa: E501 """GetCampaignOverview - a model defined in Swagger""" # noqa: E501 self._id = None @@ -57,15 +71,37 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self._type = None self._status = None self._scheduled_at = None + self._ab_testing = None + self._subject_a = None + self._subject_b = None + self._split_rule = None + self._winner_criteria = None + self._winner_delay = None + self._send_at_best_time = None self.discriminator = None self.id = id self.name = name - self.subject = subject + if subject is not None: + self.subject = subject self.type = type self.status = status if scheduled_at is not None: self.scheduled_at = scheduled_at + if ab_testing is not None: + self.ab_testing = ab_testing + if subject_a is not None: + self.subject_a = subject_a + if subject_b is not None: + self.subject_b = subject_b + if split_rule is not None: + self.split_rule = split_rule + if winner_criteria is not None: + self.winner_criteria = winner_criteria + if winner_delay is not None: + self.winner_delay = winner_delay + if send_at_best_time is not None: + self.send_at_best_time = send_at_best_time @property def id(self): @@ -121,7 +157,7 @@ def name(self, name): def subject(self): """Gets the subject of this GetCampaignOverview. # noqa: E501 - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :return: The subject of this GetCampaignOverview. # noqa: E501 :rtype: str @@ -132,13 +168,11 @@ def subject(self): def subject(self, subject): """Sets the subject of this GetCampaignOverview. - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :param subject: The subject of this GetCampaignOverview. # noqa: E501 :type: str """ - if subject is None: - raise ValueError("Invalid value for `subject`, must not be `None`") # noqa: E501 self._subject = subject @@ -227,6 +261,167 @@ def scheduled_at(self, scheduled_at): self._scheduled_at = scheduled_at + @property + def ab_testing(self): + """Gets the ab_testing of this GetCampaignOverview. # noqa: E501 + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :return: The ab_testing of this GetCampaignOverview. # noqa: E501 + :rtype: bool + """ + return self._ab_testing + + @ab_testing.setter + def ab_testing(self, ab_testing): + """Sets the ab_testing of this GetCampaignOverview. + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :param ab_testing: The ab_testing of this GetCampaignOverview. # noqa: E501 + :type: bool + """ + + self._ab_testing = ab_testing + + @property + def subject_a(self): + """Gets the subject_a of this GetCampaignOverview. # noqa: E501 + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_a of this GetCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._subject_a + + @subject_a.setter + def subject_a(self, subject_a): + """Sets the subject_a of this GetCampaignOverview. + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_a: The subject_a of this GetCampaignOverview. # noqa: E501 + :type: str + """ + + self._subject_a = subject_a + + @property + def subject_b(self): + """Gets the subject_b of this GetCampaignOverview. # noqa: E501 + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_b of this GetCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._subject_b + + @subject_b.setter + def subject_b(self, subject_b): + """Sets the subject_b of this GetCampaignOverview. + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_b: The subject_b of this GetCampaignOverview. # noqa: E501 + :type: str + """ + + self._subject_b = subject_b + + @property + def split_rule(self): + """Gets the split_rule of this GetCampaignOverview. # noqa: E501 + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The split_rule of this GetCampaignOverview. # noqa: E501 + :rtype: int + """ + return self._split_rule + + @split_rule.setter + def split_rule(self, split_rule): + """Sets the split_rule of this GetCampaignOverview. + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param split_rule: The split_rule of this GetCampaignOverview. # noqa: E501 + :type: int + """ + + self._split_rule = split_rule + + @property + def winner_criteria(self): + """Gets the winner_criteria of this GetCampaignOverview. # noqa: E501 + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_criteria of this GetCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._winner_criteria + + @winner_criteria.setter + def winner_criteria(self, winner_criteria): + """Sets the winner_criteria of this GetCampaignOverview. + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_criteria: The winner_criteria of this GetCampaignOverview. # noqa: E501 + :type: str + """ + + self._winner_criteria = winner_criteria + + @property + def winner_delay(self): + """Gets the winner_delay of this GetCampaignOverview. # noqa: E501 + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_delay of this GetCampaignOverview. # noqa: E501 + :rtype: int + """ + return self._winner_delay + + @winner_delay.setter + def winner_delay(self, winner_delay): + """Sets the winner_delay of this GetCampaignOverview. + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_delay: The winner_delay of this GetCampaignOverview. # noqa: E501 + :type: int + """ + + self._winner_delay = winner_delay + + @property + def send_at_best_time(self): + """Gets the send_at_best_time of this GetCampaignOverview. # noqa: E501 + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :return: The send_at_best_time of this GetCampaignOverview. # noqa: E501 + :rtype: bool + """ + return self._send_at_best_time + + @send_at_best_time.setter + def send_at_best_time(self, send_at_best_time): + """Sets the send_at_best_time of this GetCampaignOverview. + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :param send_at_best_time: The send_at_best_time of this GetCampaignOverview. # noqa: E501 + :type: bool + """ + + self._send_at_best_time = send_at_best_time + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/get_contact_details.py b/sib_api_v3_sdk/models/get_contact_details.py index 958c93d..5cd891c 100644 --- a/sib_api_v3_sdk/models/get_contact_details.py +++ b/sib_api_v3_sdk/models/get_contact_details.py @@ -35,6 +35,7 @@ class GetContactDetails(object): 'id': 'int', 'email_blacklisted': 'bool', 'sms_blacklisted': 'bool', + 'created_at': 'datetime', 'modified_at': 'datetime', 'list_ids': 'list[int]', 'list_unsubscribed': 'list[int]', @@ -46,19 +47,21 @@ class GetContactDetails(object): 'id': 'id', 'email_blacklisted': 'emailBlacklisted', 'sms_blacklisted': 'smsBlacklisted', + 'created_at': 'createdAt', 'modified_at': 'modifiedAt', 'list_ids': 'listIds', 'list_unsubscribed': 'listUnsubscribed', 'attributes': 'attributes' } - def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted=None, modified_at=None, list_ids=None, list_unsubscribed=None, attributes=None): # noqa: E501 + def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted=None, created_at=None, modified_at=None, list_ids=None, list_unsubscribed=None, attributes=None): # noqa: E501 """GetContactDetails - a model defined in Swagger""" # noqa: E501 self._email = None self._id = None self._email_blacklisted = None self._sms_blacklisted = None + self._created_at = None self._modified_at = None self._list_ids = None self._list_unsubscribed = None @@ -69,6 +72,7 @@ def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted= self.id = id self.email_blacklisted = email_blacklisted self.sms_blacklisted = sms_blacklisted + self.created_at = created_at self.modified_at = modified_at self.list_ids = list_ids if list_unsubscribed is not None: @@ -175,6 +179,31 @@ def sms_blacklisted(self, sms_blacklisted): self._sms_blacklisted = sms_blacklisted + @property + def created_at(self): + """Gets the created_at of this GetContactDetails. # noqa: E501 + + Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501 + + :return: The created_at of this GetContactDetails. # noqa: E501 + :rtype: datetime + """ + return self._created_at + + @created_at.setter + def created_at(self, created_at): + """Sets the created_at of this GetContactDetails. + + Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501 + + :param created_at: The created_at of this GetContactDetails. # noqa: E501 + :type: datetime + """ + if created_at is None: + raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 + + self._created_at = created_at + @property def modified_at(self): """Gets the modified_at of this GetContactDetails. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_email_campaign.py b/sib_api_v3_sdk/models/get_email_campaign.py index 32e8b72..6724ce6 100644 --- a/sib_api_v3_sdk/models/get_email_campaign.py +++ b/sib_api_v3_sdk/models/get_email_campaign.py @@ -40,6 +40,13 @@ class GetEmailCampaign(object): 'type': 'str', 'status': 'str', 'scheduled_at': 'datetime', + 'ab_testing': 'bool', + 'subject_a': 'str', + 'subject_b': 'str', + 'split_rule': 'int', + 'winner_criteria': 'str', + 'winner_delay': 'int', + 'send_at_best_time': 'bool', 'test_sent': 'bool', 'header': 'str', 'footer': 'str', @@ -66,6 +73,13 @@ class GetEmailCampaign(object): 'type': 'type', 'status': 'status', 'scheduled_at': 'scheduledAt', + 'ab_testing': 'abTesting', + 'subject_a': 'subjectA', + 'subject_b': 'subjectB', + 'split_rule': 'splitRule', + 'winner_criteria': 'winnerCriteria', + 'winner_delay': 'winnerDelay', + 'send_at_best_time': 'sendAtBestTime', 'test_sent': 'testSent', 'header': 'header', 'footer': 'footer', @@ -85,7 +99,7 @@ class GetEmailCampaign(object): 'statistics': 'statistics' } - def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, recipients=None, statistics=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None, recipients=None, statistics=None): # noqa: E501 """GetEmailCampaign - a model defined in Swagger""" # noqa: E501 self._id = None @@ -94,6 +108,13 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self._type = None self._status = None self._scheduled_at = None + self._ab_testing = None + self._subject_a = None + self._subject_b = None + self._split_rule = None + self._winner_criteria = None + self._winner_delay = None + self._send_at_best_time = None self._test_sent = None self._header = None self._footer = None @@ -115,11 +136,26 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self.id = id self.name = name - self.subject = subject + if subject is not None: + self.subject = subject self.type = type self.status = status if scheduled_at is not None: self.scheduled_at = scheduled_at + if ab_testing is not None: + self.ab_testing = ab_testing + if subject_a is not None: + self.subject_a = subject_a + if subject_b is not None: + self.subject_b = subject_b + if split_rule is not None: + self.split_rule = split_rule + if winner_criteria is not None: + self.winner_criteria = winner_criteria + if winner_delay is not None: + self.winner_delay = winner_delay + if send_at_best_time is not None: + self.send_at_best_time = send_at_best_time self.test_sent = test_sent self.header = header self.footer = footer @@ -197,7 +233,7 @@ def name(self, name): def subject(self): """Gets the subject of this GetEmailCampaign. # noqa: E501 - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :return: The subject of this GetEmailCampaign. # noqa: E501 :rtype: str @@ -208,13 +244,11 @@ def subject(self): def subject(self, subject): """Sets the subject of this GetEmailCampaign. - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :param subject: The subject of this GetEmailCampaign. # noqa: E501 :type: str """ - if subject is None: - raise ValueError("Invalid value for `subject`, must not be `None`") # noqa: E501 self._subject = subject @@ -303,6 +337,167 @@ def scheduled_at(self, scheduled_at): self._scheduled_at = scheduled_at + @property + def ab_testing(self): + """Gets the ab_testing of this GetEmailCampaign. # noqa: E501 + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :return: The ab_testing of this GetEmailCampaign. # noqa: E501 + :rtype: bool + """ + return self._ab_testing + + @ab_testing.setter + def ab_testing(self, ab_testing): + """Sets the ab_testing of this GetEmailCampaign. + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :param ab_testing: The ab_testing of this GetEmailCampaign. # noqa: E501 + :type: bool + """ + + self._ab_testing = ab_testing + + @property + def subject_a(self): + """Gets the subject_a of this GetEmailCampaign. # noqa: E501 + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_a of this GetEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_a + + @subject_a.setter + def subject_a(self, subject_a): + """Sets the subject_a of this GetEmailCampaign. + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_a: The subject_a of this GetEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_a = subject_a + + @property + def subject_b(self): + """Gets the subject_b of this GetEmailCampaign. # noqa: E501 + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_b of this GetEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_b + + @subject_b.setter + def subject_b(self, subject_b): + """Sets the subject_b of this GetEmailCampaign. + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_b: The subject_b of this GetEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_b = subject_b + + @property + def split_rule(self): + """Gets the split_rule of this GetEmailCampaign. # noqa: E501 + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The split_rule of this GetEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._split_rule + + @split_rule.setter + def split_rule(self, split_rule): + """Sets the split_rule of this GetEmailCampaign. + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param split_rule: The split_rule of this GetEmailCampaign. # noqa: E501 + :type: int + """ + + self._split_rule = split_rule + + @property + def winner_criteria(self): + """Gets the winner_criteria of this GetEmailCampaign. # noqa: E501 + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_criteria of this GetEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._winner_criteria + + @winner_criteria.setter + def winner_criteria(self, winner_criteria): + """Sets the winner_criteria of this GetEmailCampaign. + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_criteria: The winner_criteria of this GetEmailCampaign. # noqa: E501 + :type: str + """ + + self._winner_criteria = winner_criteria + + @property + def winner_delay(self): + """Gets the winner_delay of this GetEmailCampaign. # noqa: E501 + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_delay of this GetEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._winner_delay + + @winner_delay.setter + def winner_delay(self, winner_delay): + """Sets the winner_delay of this GetEmailCampaign. + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_delay: The winner_delay of this GetEmailCampaign. # noqa: E501 + :type: int + """ + + self._winner_delay = winner_delay + + @property + def send_at_best_time(self): + """Gets the send_at_best_time of this GetEmailCampaign. # noqa: E501 + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :return: The send_at_best_time of this GetEmailCampaign. # noqa: E501 + :rtype: bool + """ + return self._send_at_best_time + + @send_at_best_time.setter + def send_at_best_time(self, send_at_best_time): + """Sets the send_at_best_time of this GetEmailCampaign. + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :param send_at_best_time: The send_at_best_time of this GetEmailCampaign. # noqa: E501 + :type: bool + """ + + self._send_at_best_time = send_at_best_time + @property def test_sent(self): """Gets the test_sent of this GetEmailCampaign. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_extended_campaign_overview.py b/sib_api_v3_sdk/models/get_extended_campaign_overview.py index d9912cd..b6745f2 100644 --- a/sib_api_v3_sdk/models/get_extended_campaign_overview.py +++ b/sib_api_v3_sdk/models/get_extended_campaign_overview.py @@ -40,6 +40,13 @@ class GetExtendedCampaignOverview(object): 'type': 'str', 'status': 'str', 'scheduled_at': 'datetime', + 'ab_testing': 'bool', + 'subject_a': 'str', + 'subject_b': 'str', + 'split_rule': 'int', + 'winner_criteria': 'str', + 'winner_delay': 'int', + 'send_at_best_time': 'bool', 'test_sent': 'bool', 'header': 'str', 'footer': 'str', @@ -64,6 +71,13 @@ class GetExtendedCampaignOverview(object): 'type': 'type', 'status': 'status', 'scheduled_at': 'scheduledAt', + 'ab_testing': 'abTesting', + 'subject_a': 'subjectA', + 'subject_b': 'subjectB', + 'split_rule': 'splitRule', + 'winner_criteria': 'winnerCriteria', + 'winner_delay': 'winnerDelay', + 'send_at_best_time': 'sendAtBestTime', 'test_sent': 'testSent', 'header': 'header', 'footer': 'footer', @@ -81,7 +95,7 @@ class GetExtendedCampaignOverview(object): 'sent_date': 'sentDate' } - def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None): # noqa: E501 + def __init__(self, id=None, name=None, subject=None, type=None, status=None, scheduled_at=None, ab_testing=None, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None, send_at_best_time=None, test_sent=None, header=None, footer=None, sender=None, reply_to=None, to_field=None, html_content=None, share_link=None, tag=None, created_at=None, modified_at=None, inline_image_activation=None, mirror_active=None, recurring=None, sent_date=None): # noqa: E501 """GetExtendedCampaignOverview - a model defined in Swagger""" # noqa: E501 self._id = None @@ -90,6 +104,13 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self._type = None self._status = None self._scheduled_at = None + self._ab_testing = None + self._subject_a = None + self._subject_b = None + self._split_rule = None + self._winner_criteria = None + self._winner_delay = None + self._send_at_best_time = None self._test_sent = None self._header = None self._footer = None @@ -109,11 +130,26 @@ def __init__(self, id=None, name=None, subject=None, type=None, status=None, sch self.id = id self.name = name - self.subject = subject + if subject is not None: + self.subject = subject self.type = type self.status = status if scheduled_at is not None: self.scheduled_at = scheduled_at + if ab_testing is not None: + self.ab_testing = ab_testing + if subject_a is not None: + self.subject_a = subject_a + if subject_b is not None: + self.subject_b = subject_b + if split_rule is not None: + self.split_rule = split_rule + if winner_criteria is not None: + self.winner_criteria = winner_criteria + if winner_delay is not None: + self.winner_delay = winner_delay + if send_at_best_time is not None: + self.send_at_best_time = send_at_best_time self.test_sent = test_sent self.header = header self.footer = footer @@ -189,7 +225,7 @@ def name(self, name): def subject(self): """Gets the subject of this GetExtendedCampaignOverview. # noqa: E501 - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :return: The subject of this GetExtendedCampaignOverview. # noqa: E501 :rtype: str @@ -200,13 +236,11 @@ def subject(self): def subject(self, subject): """Sets the subject of this GetExtendedCampaignOverview. - Subject of the campaign # noqa: E501 + Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` # noqa: E501 :param subject: The subject of this GetExtendedCampaignOverview. # noqa: E501 :type: str """ - if subject is None: - raise ValueError("Invalid value for `subject`, must not be `None`") # noqa: E501 self._subject = subject @@ -295,6 +329,167 @@ def scheduled_at(self, scheduled_at): self._scheduled_at = scheduled_at + @property + def ab_testing(self): + """Gets the ab_testing of this GetExtendedCampaignOverview. # noqa: E501 + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :return: The ab_testing of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: bool + """ + return self._ab_testing + + @ab_testing.setter + def ab_testing(self, ab_testing): + """Sets the ab_testing of this GetExtendedCampaignOverview. + + Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. # noqa: E501 + + :param ab_testing: The ab_testing of this GetExtendedCampaignOverview. # noqa: E501 + :type: bool + """ + + self._ab_testing = ab_testing + + @property + def subject_a(self): + """Gets the subject_a of this GetExtendedCampaignOverview. # noqa: E501 + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_a of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._subject_a + + @subject_a.setter + def subject_a(self, subject_a): + """Sets the subject_a of this GetExtendedCampaignOverview. + + Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_a: The subject_a of this GetExtendedCampaignOverview. # noqa: E501 + :type: str + """ + + self._subject_a = subject_a + + @property + def subject_b(self): + """Gets the subject_b of this GetExtendedCampaignOverview. # noqa: E501 + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The subject_b of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._subject_b + + @subject_b.setter + def subject_b(self, subject_b): + """Sets the subject_b of this GetExtendedCampaignOverview. + + Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param subject_b: The subject_b of this GetExtendedCampaignOverview. # noqa: E501 + :type: str + """ + + self._subject_b = subject_b + + @property + def split_rule(self): + """Gets the split_rule of this GetExtendedCampaignOverview. # noqa: E501 + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The split_rule of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: int + """ + return self._split_rule + + @split_rule.setter + def split_rule(self, split_rule): + """Sets the split_rule of this GetExtendedCampaignOverview. + + The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param split_rule: The split_rule of this GetExtendedCampaignOverview. # noqa: E501 + :type: int + """ + + self._split_rule = split_rule + + @property + def winner_criteria(self): + """Gets the winner_criteria of this GetExtendedCampaignOverview. # noqa: E501 + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_criteria of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: str + """ + return self._winner_criteria + + @winner_criteria.setter + def winner_criteria(self, winner_criteria): + """Sets the winner_criteria of this GetExtendedCampaignOverview. + + Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_criteria: The winner_criteria of this GetExtendedCampaignOverview. # noqa: E501 + :type: str + """ + + self._winner_criteria = winner_criteria + + @property + def winner_delay(self): + """Gets the winner_delay of this GetExtendedCampaignOverview. # noqa: E501 + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :return: The winner_delay of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: int + """ + return self._winner_delay + + @winner_delay.setter + def winner_delay(self, winner_delay): + """Sets the winner_delay of this GetExtendedCampaignOverview. + + The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` # noqa: E501 + + :param winner_delay: The winner_delay of this GetExtendedCampaignOverview. # noqa: E501 + :type: int + """ + + self._winner_delay = winner_delay + + @property + def send_at_best_time(self): + """Gets the send_at_best_time of this GetExtendedCampaignOverview. # noqa: E501 + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :return: The send_at_best_time of this GetExtendedCampaignOverview. # noqa: E501 + :rtype: bool + """ + return self._send_at_best_time + + @send_at_best_time.setter + def send_at_best_time(self, send_at_best_time): + """Sets the send_at_best_time of this GetExtendedCampaignOverview. + + It is true if you have chosen to send your campaign at best time, otherwise it is false # noqa: E501 + + :param send_at_best_time: The send_at_best_time of this GetExtendedCampaignOverview. # noqa: E501 + :type: bool + """ + + self._send_at_best_time = send_at_best_time + @property def test_sent(self): """Gets the test_sent of this GetExtendedCampaignOverview. # noqa: E501 diff --git a/sib_api_v3_sdk/models/get_extended_contact_details.py b/sib_api_v3_sdk/models/get_extended_contact_details.py index 6f5874d..9caa9ee 100644 --- a/sib_api_v3_sdk/models/get_extended_contact_details.py +++ b/sib_api_v3_sdk/models/get_extended_contact_details.py @@ -38,6 +38,7 @@ class GetExtendedContactDetails(object): 'id': 'int', 'email_blacklisted': 'bool', 'sms_blacklisted': 'bool', + 'created_at': 'datetime', 'modified_at': 'datetime', 'list_ids': 'list[int]', 'list_unsubscribed': 'list[int]', @@ -50,6 +51,7 @@ class GetExtendedContactDetails(object): 'id': 'id', 'email_blacklisted': 'emailBlacklisted', 'sms_blacklisted': 'smsBlacklisted', + 'created_at': 'createdAt', 'modified_at': 'modifiedAt', 'list_ids': 'listIds', 'list_unsubscribed': 'listUnsubscribed', @@ -57,13 +59,14 @@ class GetExtendedContactDetails(object): 'statistics': 'statistics' } - def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted=None, modified_at=None, list_ids=None, list_unsubscribed=None, attributes=None, statistics=None): # noqa: E501 + def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted=None, created_at=None, modified_at=None, list_ids=None, list_unsubscribed=None, attributes=None, statistics=None): # noqa: E501 """GetExtendedContactDetails - a model defined in Swagger""" # noqa: E501 self._email = None self._id = None self._email_blacklisted = None self._sms_blacklisted = None + self._created_at = None self._modified_at = None self._list_ids = None self._list_unsubscribed = None @@ -75,6 +78,7 @@ def __init__(self, email=None, id=None, email_blacklisted=None, sms_blacklisted= self.id = id self.email_blacklisted = email_blacklisted self.sms_blacklisted = sms_blacklisted + self.created_at = created_at self.modified_at = modified_at self.list_ids = list_ids if list_unsubscribed is not None: @@ -182,6 +186,31 @@ def sms_blacklisted(self, sms_blacklisted): self._sms_blacklisted = sms_blacklisted + @property + def created_at(self): + """Gets the created_at of this GetExtendedContactDetails. # noqa: E501 + + Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501 + + :return: The created_at of this GetExtendedContactDetails. # noqa: E501 + :rtype: datetime + """ + return self._created_at + + @created_at.setter + def created_at(self, created_at): + """Sets the created_at of this GetExtendedContactDetails. + + Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) # noqa: E501 + + :param created_at: The created_at of this GetExtendedContactDetails. # noqa: E501 + :type: datetime + """ + if created_at is None: + raise ValueError("Invalid value for `created_at`, must not be `None`") # noqa: E501 + + self._created_at = created_at + @property def modified_at(self): """Gets the modified_at of this GetExtendedContactDetails. # noqa: E501 diff --git a/sib_api_v3_sdk/models/request_contact_export.py b/sib_api_v3_sdk/models/request_contact_export.py index a8d77f4..9c43dd4 100644 --- a/sib_api_v3_sdk/models/request_contact_export.py +++ b/sib_api_v3_sdk/models/request_contact_export.py @@ -83,7 +83,7 @@ def export_attributes(self, export_attributes): def contact_filter(self): """Gets the contact_filter of this RequestContactExport. # noqa: E501 - Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. # noqa: E501 + Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts. # noqa: E501 :return: The contact_filter of this RequestContactExport. # noqa: E501 :rtype: object @@ -94,7 +94,7 @@ def contact_filter(self): def contact_filter(self, contact_filter): """Sets the contact_filter of this RequestContactExport. - Set the filter for the contacts to be exported. For example, {'blacklisted':true} will export all the blacklisted contacts. # noqa: E501 + Set the filter for the contacts to be exported. For example, `{\"blacklisted\":true}` will export all the blacklisted contacts. # noqa: E501 :param contact_filter: The contact_filter of this RequestContactExport. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/send_email.py b/sib_api_v3_sdk/models/send_email.py index 5f21467..5d9c827 100644 --- a/sib_api_v3_sdk/models/send_email.py +++ b/sib_api_v3_sdk/models/send_email.py @@ -209,7 +209,7 @@ def attachment_url(self, attachment_url): def attachment(self): """Gets the attachment of this SendEmail. # noqa: E501 - Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. # noqa: E501 + Pass the list of content (base64 encoded) and name of the attachment. For example, `[{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]` # noqa: E501 :return: The attachment of this SendEmail. # noqa: E501 :rtype: list[SendEmailAttachment] @@ -220,7 +220,7 @@ def attachment(self): def attachment(self, attachment): """Sets the attachment of this SendEmail. - Pass the list of content (base64 encoded) and name of the attachment. For example, [{'content':'base64 encoded content 1', 'name':'attcahment1'}, {'content':'base64 encoded content 2', 'name':'attcahment2'}]. # noqa: E501 + Pass the list of content (base64 encoded) and name of the attachment. For example, `[{\"content\":\"base64 encoded content 1\", \"name\":\"attcahment1\"}, {\"content\":\"base64 encoded content 2\", \"name\":\"attcahment2\"}]` # noqa: E501 :param attachment: The attachment of this SendEmail. # noqa: E501 :type: list[SendEmailAttachment] @@ -232,7 +232,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendEmail. # noqa: E501 - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` # noqa: E501 :return: The headers of this SendEmail. # noqa: E501 :rtype: object @@ -243,7 +243,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendEmail. - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` # noqa: E501 :param headers: The headers of this SendEmail. # noqa: E501 :type: object @@ -255,7 +255,7 @@ def headers(self, headers): def attributes(self): """Gets the attributes of this SendEmail. # noqa: E501 - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} # noqa: E501 + Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} # noqa: E501 :return: The attributes of this SendEmail. # noqa: E501 :rtype: object @@ -266,7 +266,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this SendEmail. - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'} # noqa: E501 + Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"} # noqa: E501 :param attributes: The attributes of this SendEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index 93b59a7..6a4b6eb 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -138,7 +138,7 @@ def sender(self, sender): def to(self): """Gets the to of this SendSmtpEmail. # noqa: E501 - List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] # noqa: E501 + List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]` # noqa: E501 :return: The to of this SendSmtpEmail. # noqa: E501 :rtype: list[SendSmtpEmailTo] @@ -149,7 +149,7 @@ def to(self): def to(self, to): """Sets the to of this SendSmtpEmail. - List of email addresses and names (optional) of the recipients. For example, [{'name':'Jimmy', 'email':'jimmy98@example.com'}, {'name':'Joe', 'email':'joe@example.com'}] # noqa: E501 + List of email addresses and names (optional) of the recipients. For example, `[{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]` # noqa: E501 :param to: The to of this SendSmtpEmail. # noqa: E501 :type: list[SendSmtpEmailTo] @@ -299,7 +299,7 @@ def reply_to(self, reply_to): def attachment(self): """Gets the attachment of this SendSmtpEmail. # noqa: E501 - Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( Ignored if 'templateId' is passed ) # noqa: E501 + Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) # noqa: E501 :return: The attachment of this SendSmtpEmail. # noqa: E501 :rtype: list[SendSmtpEmailAttachment] @@ -310,7 +310,7 @@ def attachment(self): def attachment(self, attachment): """Sets the attachment of this SendSmtpEmail. - Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, [{'url':'https://attachment.domain.com/myAttachmentFromUrl.jpg', 'name':'My attachment 1'}, {'content':'base64 exmaple content', 'name':'My attachment 2'}]. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( Ignored if 'templateId' is passed ) # noqa: E501 + Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"My attachment 1\"}, {\"content\":\"base64 exmaple content\", \"name\":\"My attachment 2\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps and odt ( If 'templateId' is passed and is in New Template Language format then only attachment url is accepted. If template is in Old template Language format, then 'attachment' is ignored ) # noqa: E501 :param attachment: The attachment of this SendSmtpEmail. # noqa: E501 :type: list[SendSmtpEmailAttachment] @@ -322,7 +322,7 @@ def attachment(self, attachment): def headers(self): """Gets the headers of this SendSmtpEmail. # noqa: E501 - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` # noqa: E501 :return: The headers of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -333,7 +333,7 @@ def headers(self): def headers(self, headers): """Sets the headers of this SendSmtpEmail. - Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, {'Content-Type':'text/html', 'charset':'iso-8859-1', 'sender.ip':'1.2.3.4'} # noqa: E501 + Pass the set of headers that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. For example, `{\"Content-Type\":\"text/html\", \"charset\":\"iso-8859-1\", \"sender.ip\":\"1.2.3.4\"}` # noqa: E501 :param headers: The headers of this SendSmtpEmail. # noqa: E501 :type: object @@ -368,7 +368,7 @@ def template_id(self, template_id): def params(self): """Gets the params of this SendSmtpEmail. # noqa: E501 - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. # noqa: E501 + Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format. # noqa: E501 :return: The params of this SendSmtpEmail. # noqa: E501 :rtype: object @@ -379,7 +379,7 @@ def params(self): def params(self, params): """Sets the params of this SendSmtpEmail. - Pass the set of attributes to customize the template. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if template is in New Template Language format. # noqa: E501 + Pass the set of attributes to customize the template. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. It's considered only if template is in New Template Language format. # noqa: E501 :param params: The params of this SendSmtpEmail. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/update_attribute.py b/sib_api_v3_sdk/models/update_attribute.py index 6cfdff7..e05f155 100644 --- a/sib_api_v3_sdk/models/update_attribute.py +++ b/sib_api_v3_sdk/models/update_attribute.py @@ -81,7 +81,7 @@ def value(self, value): def enumeration(self): """Gets the enumeration of this UpdateAttribute. # noqa: E501 - List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` # noqa: E501 :return: The enumeration of this UpdateAttribute. # noqa: E501 :rtype: list[UpdateAttributeEnumeration] @@ -92,7 +92,7 @@ def enumeration(self): def enumeration(self, enumeration): """Sets the enumeration of this UpdateAttribute. - List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] # noqa: E501 + List of the values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, `[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]` # noqa: E501 :param enumeration: The enumeration of this UpdateAttribute. # noqa: E501 :type: list[UpdateAttributeEnumeration] diff --git a/sib_api_v3_sdk/models/update_contact.py b/sib_api_v3_sdk/models/update_contact.py index de43f39..1d12a07 100644 --- a/sib_api_v3_sdk/models/update_contact.py +++ b/sib_api_v3_sdk/models/update_contact.py @@ -76,7 +76,7 @@ def __init__(self, attributes=None, email_blacklisted=None, sms_blacklisted=None def attributes(self): """Gets the attributes of this UpdateContact. # noqa: E501 - Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} # noqa: E501 + Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}` # noqa: E501 :return: The attributes of this UpdateContact. # noqa: E501 :rtype: object @@ -87,7 +87,7 @@ def attributes(self): def attributes(self, attributes): """Sets the attributes of this UpdateContact. - Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For eg. { 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'} # noqa: E501 + Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, `{ 'EMAIL':'newemail@domain.com', 'FNAME':'Ellie', 'LNAME':'Roger'}` # noqa: E501 :param attributes: The attributes of this UpdateContact. # noqa: E501 :type: object diff --git a/sib_api_v3_sdk/models/update_email_campaign.py b/sib_api_v3_sdk/models/update_email_campaign.py index 8684dbd..68f7953 100644 --- a/sib_api_v3_sdk/models/update_email_campaign.py +++ b/sib_api_v3_sdk/models/update_email_campaign.py @@ -52,7 +52,13 @@ class UpdateEmailCampaign(object): 'header': 'str', 'utm_campaign': 'str', 'params': 'object', - 'send_at_best_time': 'bool' + 'send_at_best_time': 'bool', + 'ab_testing': 'bool', + 'subject_a': 'str', + 'subject_b': 'str', + 'split_rule': 'int', + 'winner_criteria': 'str', + 'winner_delay': 'int' } attribute_map = { @@ -74,10 +80,16 @@ class UpdateEmailCampaign(object): 'header': 'header', 'utm_campaign': 'utmCampaign', 'params': 'params', - 'send_at_best_time': 'sendAtBestTime' + 'send_at_best_time': 'sendAtBestTime', + 'ab_testing': 'abTesting', + 'subject_a': 'subjectA', + 'subject_b': 'subjectB', + 'split_rule': 'splitRule', + 'winner_criteria': 'winnerCriteria', + 'winner_delay': 'winnerDelay' } - def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None): # noqa: E501 + def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url=None, scheduled_at=None, subject=None, reply_to=None, to_field=None, recipients=None, attachment_url=None, inline_image_activation=False, mirror_active=None, recurring=False, footer=None, header=None, utm_campaign=None, params=None, send_at_best_time=None, ab_testing=False, subject_a=None, subject_b=None, split_rule=None, winner_criteria=None, winner_delay=None): # noqa: E501 """UpdateEmailCampaign - a model defined in Swagger""" # noqa: E501 self._tag = None @@ -99,6 +111,12 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url self._utm_campaign = None self._params = None self._send_at_best_time = None + self._ab_testing = None + self._subject_a = None + self._subject_b = None + self._split_rule = None + self._winner_criteria = None + self._winner_delay = None self.discriminator = None if tag is not None: @@ -139,6 +157,18 @@ def __init__(self, tag=None, sender=None, name=None, html_content=None, html_url self.params = params if send_at_best_time is not None: self.send_at_best_time = send_at_best_time + if ab_testing is not None: + self.ab_testing = ab_testing + if subject_a is not None: + self.subject_a = subject_a + if subject_b is not None: + self.subject_b = subject_b + if split_rule is not None: + self.split_rule = split_rule + if winner_criteria is not None: + self.winner_criteria = winner_criteria + if winner_delay is not None: + self.winner_delay = winner_delay @property def tag(self): @@ -326,7 +356,7 @@ def reply_to(self, reply_to): def to_field(self): """Gets the to_field of this UpdateEmailCampaign. # noqa: E501 - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :return: The to_field of this UpdateEmailCampaign. # noqa: E501 :rtype: str @@ -337,7 +367,7 @@ def to_field(self): def to_field(self, to_field): """Sets the to_field of this UpdateEmailCampaign. - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :param to_field: The to_field of this UpdateEmailCampaign. # noqa: E501 :type: str @@ -531,7 +561,7 @@ def utm_campaign(self, utm_campaign): def params(self): """Gets the params of this UpdateEmailCampaign. # noqa: E501 - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :return: The params of this UpdateEmailCampaign. # noqa: E501 :rtype: object @@ -542,7 +572,7 @@ def params(self): def params(self, params): """Sets the params of this UpdateEmailCampaign. - Pass the set of attributes to customize the type 'classic' campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 + Pass the set of attributes to customize the type 'classic' campaign. For example, `{\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}`. The 'params' field will get updated, only if the campaign is in New Template Language, else ignored. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' # noqa: E501 :param params: The params of this UpdateEmailCampaign. # noqa: E501 :type: object @@ -573,6 +603,158 @@ def send_at_best_time(self, send_at_best_time): self._send_at_best_time = send_at_best_time + @property + def ab_testing(self): + """Gets the ab_testing of this UpdateEmailCampaign. # noqa: E501 + + Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501 + + :return: The ab_testing of this UpdateEmailCampaign. # noqa: E501 + :rtype: bool + """ + return self._ab_testing + + @ab_testing.setter + def ab_testing(self, ab_testing): + """Sets the ab_testing of this UpdateEmailCampaign. + + Status of A/B Test. abTesting = false means it is disabled, & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule', 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B # noqa: E501 + + :param ab_testing: The ab_testing of this UpdateEmailCampaign. # noqa: E501 + :type: bool + """ + + self._ab_testing = ab_testing + + @property + def subject_a(self): + """Gets the subject_a of this UpdateEmailCampaign. # noqa: E501 + + Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :return: The subject_a of this UpdateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_a + + @subject_a.setter + def subject_a(self, subject_a): + """Sets the subject_a of this UpdateEmailCampaign. + + Subject A of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :param subject_a: The subject_a of this UpdateEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_a = subject_a + + @property + def subject_b(self): + """Gets the subject_b of this UpdateEmailCampaign. # noqa: E501 + + Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :return: The subject_b of this UpdateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._subject_b + + @subject_b.setter + def subject_b(self, subject_b): + """Sets the subject_b of this UpdateEmailCampaign. + + Subject B of the campaign. Considered if abTesting = true. subjectA & subjectB should have unique value # noqa: E501 + + :param subject_b: The subject_b of this UpdateEmailCampaign. # noqa: E501 + :type: str + """ + + self._subject_b = subject_b + + @property + def split_rule(self): + """Gets the split_rule of this UpdateEmailCampaign. # noqa: E501 + + Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501 + + :return: The split_rule of this UpdateEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._split_rule + + @split_rule.setter + def split_rule(self, split_rule): + """Sets the split_rule of this UpdateEmailCampaign. + + Add the size of your test groups. Considered if abTesting = true. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else # noqa: E501 + + :param split_rule: The split_rule of this UpdateEmailCampaign. # noqa: E501 + :type: int + """ + if split_rule is not None and split_rule > 50: # noqa: E501 + raise ValueError("Invalid value for `split_rule`, must be a value less than or equal to `50`") # noqa: E501 + if split_rule is not None and split_rule < 1: # noqa: E501 + raise ValueError("Invalid value for `split_rule`, must be a value greater than or equal to `1`") # noqa: E501 + + self._split_rule = split_rule + + @property + def winner_criteria(self): + """Gets the winner_criteria of this UpdateEmailCampaign. # noqa: E501 + + Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record # noqa: E501 + + :return: The winner_criteria of this UpdateEmailCampaign. # noqa: E501 + :rtype: str + """ + return self._winner_criteria + + @winner_criteria.setter + def winner_criteria(self, winner_criteria): + """Sets the winner_criteria of this UpdateEmailCampaign. + + Choose the metrics that will determinate the winning version. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria' is ignored if passed or alreday exist in record # noqa: E501 + + :param winner_criteria: The winner_criteria of this UpdateEmailCampaign. # noqa: E501 + :type: str + """ + allowed_values = ["open", "click"] # noqa: E501 + if winner_criteria not in allowed_values: + raise ValueError( + "Invalid value for `winner_criteria` ({0}), must be one of {1}" # noqa: E501 + .format(winner_criteria, allowed_values) + ) + + self._winner_criteria = winner_criteria + + @property + def winner_delay(self): + """Gets the winner_delay of this UpdateEmailCampaign. # noqa: E501 + + Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record # noqa: E501 + + :return: The winner_delay of this UpdateEmailCampaign. # noqa: E501 + :rtype: int + """ + return self._winner_delay + + @winner_delay.setter + def winner_delay(self, winner_delay): + """Sets the winner_delay of this UpdateEmailCampaign. + + Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay' is ignored if passed or alreday exist in record # noqa: E501 + + :param winner_delay: The winner_delay of this UpdateEmailCampaign. # noqa: E501 + :type: int + """ + if winner_delay is not None and winner_delay > 168: # noqa: E501 + raise ValueError("Invalid value for `winner_delay`, must be a value less than or equal to `168`") # noqa: E501 + if winner_delay is not None and winner_delay < 1: # noqa: E501 + raise ValueError("Invalid value for `winner_delay`, must be a value greater than or equal to `1`") # noqa: E501 + + self._winner_delay = winner_delay + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/update_smtp_template.py b/sib_api_v3_sdk/models/update_smtp_template.py index b589ef4..02ef100 100644 --- a/sib_api_v3_sdk/models/update_smtp_template.py +++ b/sib_api_v3_sdk/models/update_smtp_template.py @@ -257,7 +257,7 @@ def reply_to(self, reply_to): def to_field(self): """Gets the to_field of this UpdateSmtpTemplate. # noqa: E501 - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :return: The to_field of this UpdateSmtpTemplate. # noqa: E501 :rtype: str @@ -268,7 +268,7 @@ def to_field(self): def to_field(self, to_field): """Sets the to_field of this UpdateSmtpTemplate. - To personalize the «To» Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization # noqa: E501 + To personalize the «To» Field. If you want to include the first name and last name of your recipient, add `{FNAME} {LNAME}`. These contact attributes must already exist in your SendinBlue account. If input parameter 'params' used please use `{{contact.FNAME}} {{contact.LNAME}}` for personalization # noqa: E501 :param to_field: The to_field of this UpdateSmtpTemplate. # noqa: E501 :type: str