diff --git a/docs/ContactsApi.md b/docs/ContactsApi.md index 7f7ae3f..6d46ac7 100644 --- a/docs/ContactsApi.md +++ b/docs/ContactsApi.md @@ -805,7 +805,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document of the page (optional) (default to 0) modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all the contacts @@ -822,7 +822,7 @@ Name | Type | Description | Notes **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] **modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -869,7 +869,7 @@ list_id = 789 # int | Id of the list modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get contacts in a list @@ -887,7 +887,7 @@ Name | Type | Description | Notes **modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -990,7 +990,7 @@ api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration folder_id = 789 # int | Id of the folder limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get lists in a folder @@ -1007,7 +1007,7 @@ Name | Type | Description | Notes **folder_id** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -1052,7 +1052,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 # int | Number of documents per page (default to 10) offset = 0 # int | Index of the first document of the page (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all folders @@ -1068,7 +1068,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [default to 10] **offset** | **int**| Index of the first document of the page | [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -1170,7 +1170,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.ContactsApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all the lists @@ -1186,7 +1186,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/CreateSmtpEmail.md b/docs/CreateSmtpEmail.md index 7c0fc7b..3ceb85b 100644 --- a/docs/CreateSmtpEmail.md +++ b/docs/CreateSmtpEmail.md @@ -3,7 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**message_id** | **str** | Message ID of the transactional email sent | +**message_id** | **str** | Message ID of the transactional email sent | [optional] +**message_ids** | **list[str]** | | [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 18850c7..b0e29d5 100644 --- a/docs/EmailCampaignsApi.md +++ b/docs/EmailCampaignsApi.md @@ -339,7 +339,7 @@ start_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if endDate is us end_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) limit = 500 # int | Number of documents per page (optional) (default to 500) offset = 0 # int | Index of the first document in the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Return all your created email campaigns @@ -359,7 +359,7 @@ Name | Type | Description | Notes **end_date** | **datetime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 500] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/FoldersApi.md b/docs/FoldersApi.md index 58ea530..76b1731 100644 --- a/docs/FoldersApi.md +++ b/docs/FoldersApi.md @@ -211,7 +211,7 @@ api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration) folder_id = 789 # int | Id of the folder limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get lists in a folder @@ -228,7 +228,7 @@ Name | Type | Description | Notes **folder_id** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -273,7 +273,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.FoldersApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 # int | Number of documents per page (default to 10) offset = 0 # int | Index of the first document of the page (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all folders @@ -289,7 +289,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [default to 10] **offset** | **int**| Index of the first document of the page | [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/ListsApi.md b/docs/ListsApi.md index d9e036f..a742b0f 100644 --- a/docs/ListsApi.md +++ b/docs/ListsApi.md @@ -217,7 +217,7 @@ list_id = 789 # int | Id of the list modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) limit = 50 # int | Number of documents per page (optional) (default to 50) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get contacts in a list @@ -235,7 +235,7 @@ Name | Type | Description | Notes **modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -281,7 +281,7 @@ api_instance = sib_api_v3_sdk.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) folder_id = 789 # int | Id of the folder limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get lists in a folder @@ -298,7 +298,7 @@ Name | Type | Description | Notes **folder_id** | **int**| Id of the folder | **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -400,7 +400,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.ListsApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 # int | Number of documents per page (optional) (default to 10) offset = 0 # int | Index of the first document of the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all the lists @@ -416,7 +416,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 10] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/ProcessApi.md b/docs/ProcessApi.md index 54de3eb..63d36f1 100644 --- a/docs/ProcessApi.md +++ b/docs/ProcessApi.md @@ -93,7 +93,7 @@ configuration.api_key['partner-key'] = 'YOUR_API_KEY' api_instance = sib_api_v3_sdk.ProcessApi(sib_api_v3_sdk.ApiClient(configuration)) limit = 10 # int | Number limitation for the result returned (optional) (default to 10) offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Return all the processes for your account @@ -109,7 +109,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number limitation for the result returned | [optional] [default to 10] **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/SMSCampaignsApi.md b/docs/SMSCampaignsApi.md index 10c1c82..c5f4e6a 100644 --- a/docs/SMSCampaignsApi.md +++ b/docs/SMSCampaignsApi.md @@ -217,7 +217,7 @@ start_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if endDate is us end_date = '2013-10-20T19:20:30+01:00' # datetime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) (optional) limit = 500 # int | Number limitation for the result returned (optional) (default to 500) offset = 0 # int | Beginning point in the list to retrieve from. (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Returns the information for all your created SMS campaigns @@ -236,7 +236,7 @@ Name | Type | Description | Notes **end_date** | **datetime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] **limit** | **int**| Number limitation for the result returned | [optional] [default to 500] **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/SendSmtpEmail.md b/docs/SendSmtpEmail.md index 06802a0..6e33e54 100644 --- a/docs/SendSmtpEmail.md +++ b/docs/SendSmtpEmail.md @@ -4,7 +4,7 @@ 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) | Mandatory if messageVersions are not passed, ignored if messageVersions are passed. List of email addresses and names (optional) of the recipients. For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}] | [optional] **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] @@ -13,8 +13,9 @@ Name | Type | Description | Notes **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\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. 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, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] **headers** | **object** | Pass the set of custom headers (not the standard 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. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional] -**template_id** | **int** | Id of the template | [optional] +**template_id** | **int** | Id of the template. Mandatory if messageVersions are passed | [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] +**message_versions** | [**list[SendSmtpEmailMessageVersions]**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [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/SendSmtpEmailMessageVersions.md b/docs/SendSmtpEmailMessageVersions.md new file mode 100644 index 0000000..7c718fa --- /dev/null +++ b/docs/SendSmtpEmailMessageVersions.md @@ -0,0 +1,15 @@ +# SendSmtpEmailMessageVersions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**to** | [**list[SendSmtpEmailTo1]**](SendSmtpEmailTo1.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\"}] | +**params** | **dict(str, 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] +**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] +**reply_to** | [**SendSmtpEmailReplyTo1**](SendSmtpEmailReplyTo1.md) | | [optional] +**subject** | **str** | Custom subject specific to message version | [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/SendSmtpEmailReplyTo1.md b/docs/SendSmtpEmailReplyTo1.md new file mode 100644 index 0000000..d4f870d --- /dev/null +++ b/docs/SendSmtpEmailReplyTo1.md @@ -0,0 +1,11 @@ +# SendSmtpEmailReplyTo1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | Email address in reply to | +**name** | **str** | Name in reply to. Maximum allowed characters are 70. | [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/SendSmtpEmailTo1.md b/docs/SendSmtpEmailTo1.md new file mode 100644 index 0000000..b38f636 --- /dev/null +++ b/docs/SendSmtpEmailTo1.md @@ -0,0 +1,11 @@ +# SendSmtpEmailTo1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | Email address of the recipient | +**name** | **str** | Name of the recipient. **Maximum allowed characters are 70**. | [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/TransactionalEmailsApi.md b/docs/TransactionalEmailsApi.md index 0719cea..acb84a8 100644 --- a/docs/TransactionalEmailsApi.md +++ b/docs/TransactionalEmailsApi.md @@ -4,7 +4,9 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- +[**block_new_domain**](TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains [**create_smtp_template**](TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template +[**delete_blocked_domain**](TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains [**delete_hardbounces**](TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces [**delete_smtp_template**](TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template [**get_aggregated_smtp_report**](TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time @@ -24,6 +26,64 @@ Method | HTTP request | Description [**update_smtp_template**](TransactionalEmailsApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Update an email template +# **block_new_domain** +> block_new_domain(block_domain) + +Add a new domain to the list of blocked domains + +Blocks a new domain in order to avoid messages being sent to the same + +### Example +```python +from __future__ import print_function +import time +import sib_api_v3_sdk +from sib_api_v3_sdk.rest import ApiException +from pprint import pprint + +# Configure API key authorization: api-key +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.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration)) +block_domain = sib_api_v3_sdk.BlockDomain() # BlockDomain | + +try: + # Add a new domain to the list of blocked domains + api_instance.block_new_domain(block_domain) +except ApiException as e: + print("Exception when calling TransactionalEmailsApi->block_new_domain: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **block_domain** | [**BlockDomain**](BlockDomain.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_smtp_template** > CreateModel create_smtp_template(smtp_template) @@ -81,6 +141,64 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **delete_blocked_domain** +> delete_blocked_domain(domain) + +Unblock an existing domain from the list of blocked domains + +Unblocks an existing domain from the list of blocked domains + +### Example +```python +from __future__ import print_function +import time +import sib_api_v3_sdk +from sib_api_v3_sdk.rest import ApiException +from pprint import pprint + +# Configure API key authorization: api-key +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.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration)) +domain = 'domain_example' # str | The name of the domain to be deleted + +try: + # Unblock an existing domain from the list of blocked domains + api_instance.delete_blocked_domain(domain) +except ApiException as e: + print("Exception when calling TransactionalEmailsApi->delete_blocked_domain: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **domain** | **str**| The name of the domain to be deleted | + +### Return type + +void (empty response body) + +### Authorization + +[api-key](../README.md#api-key), [partner-key](../README.md#partner-key) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_hardbounces** > delete_hardbounces(delete_hardbounces=delete_hardbounces) @@ -349,7 +467,7 @@ event = 'event_example' # str | Filter the report for a specific event type (opt tags = 'tags_example' # str | Filter the report for tags (serialized and urlencoded array) (optional) message_id = 'message_id_example' # str | Filter on a specific message id (optional) template_id = 789 # int | Filter on a specific template id (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all your transactional email activity (unaggregated events) @@ -373,7 +491,7 @@ Name | Type | Description | Notes **tags** | **str**| Filter the report for tags (serialized and urlencoded array) | [optional] **message_id** | **str**| Filter on a specific message id | [optional] **template_id** | **int**| Filter on a specific template id | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -422,7 +540,7 @@ start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional) days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) tag = 'tag_example' # str | Tag of the emails (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get your transactional email activity aggregated per day @@ -442,7 +560,7 @@ Name | Type | Description | Notes **end_date** | **str**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **tag** | **str**| Tag of the emails | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -545,7 +663,7 @@ api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(co template_status = true # bool | Filter on the status of the template. Active = true, inactive = false (optional) limit = 50 # int | Number of documents returned per page (optional) (default to 50) offset = 0 # int | Index of the first document in the page (optional) (default to 0) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get the list of email templates @@ -562,7 +680,7 @@ Name | Type | Description | Notes **template_status** | **bool**| Filter on the status of the template. Active = true, inactive = false | [optional] **limit** | **int**| Number of documents returned per page | [optional] [default to 50] **offset** | **int**| Index of the first document in the page | [optional] [default to 0] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -610,7 +728,7 @@ end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending dat limit = 50 # int | Number of documents returned per page (optional) (default to 50) offset = 0 # int | Index of the first document on the page (optional) (default to 0) senders = ['senders_example'] # list[str] | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get the list of blocked or unsubscribed transactional contacts @@ -629,7 +747,7 @@ Name | Type | Description | Notes **limit** | **int**| Number of documents returned per page | [optional] [default to 50] **offset** | **int**| Index of the first document on the page | [optional] [default to 0] **senders** | [**list[str]**](str.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -736,7 +854,7 @@ template_id = 789 # int | Mandatory if email and messageId are not passed in que message_id = 'message_id_example' # str | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional) start_date = '2013-10-20' # date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional) end_date = '2013-10-20' # date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get the list of transactional emails on the basis of allowed filters @@ -755,7 +873,7 @@ Name | Type | Description | Notes **message_id** | **str**| Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. | [optional] **start_date** | **date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] **end_date** | **date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/docs/TransactionalSMSApi.md b/docs/TransactionalSMSApi.md index 3b75375..f430a3f 100644 --- a/docs/TransactionalSMSApi.md +++ b/docs/TransactionalSMSApi.md @@ -44,7 +44,7 @@ days = 56 # int | Number of days in the past including today (positive integer). phone_number = 'phone_number_example' # str | Filter the report for a specific phone number (optional) event = 'event_example' # str | Filter the report for specific events (optional) tags = 'tags_example' # str | Filter the report for specific tags passed as a serialized urlencoded array (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get all your SMS activity (unaggregated events) @@ -66,7 +66,7 @@ Name | Type | Description | Notes **phone_number** | **str**| Filter the report for a specific phone number | [optional] **event** | **str**| Filter the report for specific events | [optional] **tags** | **str**| Filter the report for specific tags passed as a serialized urlencoded array | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type @@ -176,7 +176,7 @@ start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional) days = 56 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional) tag = 'tag_example' # str | Filter on a tag (optional) -sort = 'desc' # str | Sort the results in the ascending/descending order of record creation (optional) (default to desc) +sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc) try: # Get your SMS activity aggregated per day @@ -194,7 +194,7 @@ Name | Type | Description | Notes **end_date** | **str**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] **days** | **int**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] **tag** | **str**| Filter on a tag | [optional] - **sort** | **str**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **str**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed | [optional] [default to desc] ### Return type diff --git a/setup.py b/setup.py index 0d5bd1b..f2997ae 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ from setuptools import setup, find_packages # noqa: H301 NAME = "sib-api-v3-sdk" -VERSION = "7.1.0" +VERSION = "7.2.0" # To install the library, run the following # # python setup.py install diff --git a/sib_api_v3_sdk/__init__.py b/sib_api_v3_sdk/__init__.py index 4d1d8da..6111b77 100644 --- a/sib_api_v3_sdk/__init__.py +++ b/sib_api_v3_sdk/__init__.py @@ -43,6 +43,7 @@ from sib_api_v3_sdk.models.add_child_domain import AddChildDomain from sib_api_v3_sdk.models.add_contact_to_list import AddContactToList from sib_api_v3_sdk.models.add_credits import AddCredits +from sib_api_v3_sdk.models.block_domain import BlockDomain from sib_api_v3_sdk.models.create_attribute import CreateAttribute from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild @@ -77,6 +78,7 @@ from sib_api_v3_sdk.models.get_attributes import GetAttributes from sib_api_v3_sdk.models.get_attributes_attributes import GetAttributesAttributes from sib_api_v3_sdk.models.get_attributes_enumeration import GetAttributesEnumeration +from sib_api_v3_sdk.models.get_blocked_domains import GetBlockedDomains from sib_api_v3_sdk.models.get_campaign_overview import GetCampaignOverview from sib_api_v3_sdk.models.get_campaign_recipients import GetCampaignRecipients from sib_api_v3_sdk.models.get_campaign_stats import GetCampaignStats @@ -178,9 +180,12 @@ from sib_api_v3_sdk.models.send_smtp_email_attachment import SendSmtpEmailAttachment from sib_api_v3_sdk.models.send_smtp_email_bcc import SendSmtpEmailBcc from sib_api_v3_sdk.models.send_smtp_email_cc import SendSmtpEmailCc +from sib_api_v3_sdk.models.send_smtp_email_message_versions import SendSmtpEmailMessageVersions from sib_api_v3_sdk.models.send_smtp_email_reply_to import SendSmtpEmailReplyTo +from sib_api_v3_sdk.models.send_smtp_email_reply_to1 import SendSmtpEmailReplyTo1 from sib_api_v3_sdk.models.send_smtp_email_sender import SendSmtpEmailSender from sib_api_v3_sdk.models.send_smtp_email_to import SendSmtpEmailTo +from sib_api_v3_sdk.models.send_smtp_email_to1 import SendSmtpEmailTo1 from sib_api_v3_sdk.models.send_template_email import SendTemplateEmail from sib_api_v3_sdk.models.send_test_email import SendTestEmail from sib_api_v3_sdk.models.send_test_sms import SendTestSms diff --git a/sib_api_v3_sdk/api/contacts_api.py b/sib_api_v3_sdk/api/contacts_api.py index 6c36062..5990893 100644 --- a/sib_api_v3_sdk/api/contacts_api.py +++ b/sib_api_v3_sdk/api/contacts_api.py @@ -1338,7 +1338,7 @@ def get_contacts(self, **kwargs): # noqa: E501 :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -1362,7 +1362,7 @@ def get_contacts_with_http_info(self, **kwargs): # noqa: E501 :param int limit: Number of documents per page :param int offset: Index of the first document of the page :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -1446,7 +1446,7 @@ def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -1471,7 +1471,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -1657,7 +1657,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -1681,7 +1681,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -1767,7 +1767,7 @@ def get_folders(self, limit, offset, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. @@ -1790,7 +1790,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. @@ -1975,7 +1975,7 @@ def get_lists(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. @@ -1998,7 +1998,7 @@ def get_lists_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/email_campaigns_api.py b/sib_api_v3_sdk/api/email_campaigns_api.py index 01ed744..a35d020 100644 --- a/sib_api_v3_sdk/api/email_campaigns_api.py +++ b/sib_api_v3_sdk/api/email_campaigns_api.py @@ -539,7 +539,7 @@ def get_email_campaigns(self, **kwargs): # noqa: E501 :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number of documents per page :param int offset: Index of the first document in the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailCampaigns If the method is called asynchronously, returns the request thread. @@ -566,7 +566,7 @@ def get_email_campaigns_with_http_info(self, **kwargs): # noqa: E501 :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number of documents per page :param int offset: Index of the first document in the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailCampaigns If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/folders_api.py b/sib_api_v3_sdk/api/folders_api.py index ca508e0..954f521 100644 --- a/sib_api_v3_sdk/api/folders_api.py +++ b/sib_api_v3_sdk/api/folders_api.py @@ -336,7 +336,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -360,7 +360,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -446,7 +446,7 @@ def get_folders(self, limit, offset, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. @@ -469,7 +469,7 @@ def get_folders_with_http_info(self, limit, offset, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page (required) :param int offset: Index of the first document of the page (required) - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolders If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/lists_api.py b/sib_api_v3_sdk/api/lists_api.py index 8e41548..02079df 100644 --- a/sib_api_v3_sdk/api/lists_api.py +++ b/sib_api_v3_sdk/api/lists_api.py @@ -345,7 +345,7 @@ def get_contacts_from_list(self, list_id, **kwargs): # noqa: E501 :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -370,7 +370,7 @@ def get_contacts_from_list_with_http_info(self, list_id, **kwargs): # noqa: E50 :param datetime modified_since: Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetContacts If the method is called asynchronously, returns the request thread. @@ -459,7 +459,7 @@ def get_folder_lists(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -483,7 +483,7 @@ def get_folder_lists_with_http_info(self, folder_id, **kwargs): # noqa: E501 :param int folder_id: Id of the folder (required) :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetFolderLists If the method is called asynchronously, returns the request thread. @@ -666,7 +666,7 @@ def get_lists(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. @@ -689,7 +689,7 @@ def get_lists_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of documents per page :param int offset: Index of the first document of the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetLists If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/process_api.py b/sib_api_v3_sdk/api/process_api.py index a8367f9..343b79f 100644 --- a/sib_api_v3_sdk/api/process_api.py +++ b/sib_api_v3_sdk/api/process_api.py @@ -141,7 +141,7 @@ def get_processes(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number limitation for the result returned :param int offset: Beginning point in the list to retrieve from. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetProcesses If the method is called asynchronously, returns the request thread. @@ -164,7 +164,7 @@ def get_processes_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number limitation for the result returned :param int offset: Beginning point in the list to retrieve from. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetProcesses If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/sms_campaigns_api.py b/sib_api_v3_sdk/api/sms_campaigns_api.py index bac2975..72cd2ca 100644 --- a/sib_api_v3_sdk/api/sms_campaigns_api.py +++ b/sib_api_v3_sdk/api/sms_campaigns_api.py @@ -338,7 +338,7 @@ def get_sms_campaigns(self, **kwargs): # noqa: E501 :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number limitation for the result returned :param int offset: Beginning point in the list to retrieve from. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmsCampaigns If the method is called asynchronously, returns the request thread. @@ -364,7 +364,7 @@ def get_sms_campaigns_with_http_info(self, **kwargs): # noqa: E501 :param datetime end_date: Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) :param int limit: Number limitation for the result returned :param int offset: Beginning point in the list to retrieve from. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmsCampaigns If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/transactional_emails_api.py b/sib_api_v3_sdk/api/transactional_emails_api.py index 781b52b..f0185ac 100644 --- a/sib_api_v3_sdk/api/transactional_emails_api.py +++ b/sib_api_v3_sdk/api/transactional_emails_api.py @@ -33,6 +33,105 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def block_new_domain(self, block_domain, **kwargs): # noqa: E501 + """Add a new domain to the list of blocked domains # noqa: E501 + + Blocks a new domain in order to avoid messages being sent to the same # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.block_new_domain(block_domain, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BlockDomain block_domain: (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501 + else: + (data) = self.block_new_domain_with_http_info(block_domain, **kwargs) # noqa: E501 + return data + + def block_new_domain_with_http_info(self, block_domain, **kwargs): # noqa: E501 + """Add a new domain to the list of blocked domains # noqa: E501 + + Blocks a new domain in order to avoid messages being sent to the same # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.block_new_domain_with_http_info(block_domain, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BlockDomain block_domain: (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['block_domain'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method block_new_domain" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'block_domain' is set + if ('block_domain' not in params or + params['block_domain'] is None): + raise ValueError("Missing the required parameter `block_domain` when calling `block_new_domain`") # noqa: E501 + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'block_domain' in params: + body_params = params['block_domain'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['api-key', 'partner-key'] # noqa: E501 + + return self.api_client.call_api( + '/smtp/blockedDomains', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def create_smtp_template(self, smtp_template, **kwargs): # noqa: E501 """Create an email template # noqa: E501 @@ -130,6 +229,105 @@ def create_smtp_template_with_http_info(self, smtp_template, **kwargs): # noqa: _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) + def delete_blocked_domain(self, domain, **kwargs): # noqa: E501 + """Unblock an existing domain from the list of blocked domains # noqa: E501 + + Unblocks an existing domain from the list of blocked domains # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_blocked_domain(domain, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str domain: The name of the domain to be deleted (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501 + else: + (data) = self.delete_blocked_domain_with_http_info(domain, **kwargs) # noqa: E501 + return data + + def delete_blocked_domain_with_http_info(self, domain, **kwargs): # noqa: E501 + """Unblock an existing domain from the list of blocked domains # noqa: E501 + + Unblocks an existing domain from the list of blocked domains # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_blocked_domain_with_http_info(domain, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str domain: The name of the domain to be deleted (required) + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['domain'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_blocked_domain" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'domain' is set + if ('domain' not in params or + params['domain'] is None): + raise ValueError("Missing the required parameter `domain` when calling `delete_blocked_domain`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'domain' in params: + path_params['domain'] = params['domain'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['api-key', 'partner-key'] # noqa: E501 + + return self.api_client.call_api( + '/smtp/blockedDomains/{domain}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + def delete_hardbounces(self, **kwargs): # noqa: E501 """Delete hardbounces # noqa: E501 @@ -537,7 +735,7 @@ def get_email_event_report(self, **kwargs): # noqa: E501 :param str tags: Filter the report for tags (serialized and urlencoded array) :param str message_id: Filter on a specific message id :param int template_id: Filter on a specific template id - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailEventReport If the method is called asynchronously, returns the request thread. @@ -568,7 +766,7 @@ def get_email_event_report_with_http_info(self, **kwargs): # noqa: E501 :param str tags: Filter the report for tags (serialized and urlencoded array) :param str message_id: Filter on a specific message id :param int template_id: Filter on a specific template id - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetEmailEventReport If the method is called asynchronously, returns the request thread. @@ -668,7 +866,7 @@ def get_smtp_report(self, **kwargs): # noqa: E501 :param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) :param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' :param str tag: Tag of the emails - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetReports If the method is called asynchronously, returns the request thread. @@ -695,7 +893,7 @@ def get_smtp_report_with_http_info(self, **kwargs): # noqa: E501 :param str end_date: Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) :param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' :param str tag: Tag of the emails - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetReports If the method is called asynchronously, returns the request thread. @@ -881,7 +1079,7 @@ def get_smtp_templates(self, **kwargs): # noqa: E501 :param bool template_status: Filter on the status of the template. Active = true, inactive = false :param int limit: Number of documents returned per page :param int offset: Index of the first document in the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmtpTemplates If the method is called asynchronously, returns the request thread. @@ -905,7 +1103,7 @@ def get_smtp_templates_with_http_info(self, **kwargs): # noqa: E501 :param bool template_status: Filter on the status of the template. Active = true, inactive = false :param int limit: Number of documents returned per page :param int offset: Index of the first document in the page - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmtpTemplates If the method is called asynchronously, returns the request thread. @@ -990,7 +1188,7 @@ def get_transac_blocked_contacts(self, **kwargs): # noqa: E501 :param int limit: Number of documents returned per page :param int offset: Index of the first document on the page :param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacBlockedContacts If the method is called asynchronously, returns the request thread. @@ -1016,7 +1214,7 @@ def get_transac_blocked_contacts_with_http_info(self, **kwargs): # noqa: E501 :param int limit: Number of documents returned per page :param int offset: Index of the first document on the page :param list[str] senders: Comma separated list of emails of the senders from which contacts are blocked or unsubscribed - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacBlockedContacts If the method is called asynchronously, returns the request thread. @@ -1204,7 +1402,7 @@ def get_transac_emails_list(self, **kwargs): # noqa: E501 :param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. :param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacEmailsList If the method is called asynchronously, returns the request thread. @@ -1231,7 +1429,7 @@ def get_transac_emails_list_with_http_info(self, **kwargs): # noqa: E501 :param str message_id: Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. :param date start_date: Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. :param date end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacEmailsList If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api/transactional_sms_api.py b/sib_api_v3_sdk/api/transactional_sms_api.py index a44141d..903afd3 100644 --- a/sib_api_v3_sdk/api/transactional_sms_api.py +++ b/sib_api_v3_sdk/api/transactional_sms_api.py @@ -50,7 +50,7 @@ def get_sms_events(self, **kwargs): # noqa: E501 :param str phone_number: Filter the report for a specific phone number :param str event: Filter the report for specific events :param str tags: Filter the report for specific tags passed as a serialized urlencoded array - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmsEventReport If the method is called asynchronously, returns the request thread. @@ -79,7 +79,7 @@ def get_sms_events_with_http_info(self, **kwargs): # noqa: E501 :param str phone_number: Filter the report for a specific phone number :param str event: Filter the report for specific events :param str tags: Filter the report for specific tags passed as a serialized urlencoded array - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetSmsEventReport If the method is called asynchronously, returns the request thread. @@ -278,7 +278,7 @@ def get_transac_sms_report(self, **kwargs): # noqa: E501 :param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report :param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' :param str tag: Filter on a tag - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacSmsReport If the method is called asynchronously, returns the request thread. @@ -303,7 +303,7 @@ def get_transac_sms_report_with_http_info(self, **kwargs): # noqa: E501 :param str end_date: Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report :param int days: Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' :param str tag: Filter on a tag - :param str sort: Sort the results in the ascending/descending order of record creation + :param str sort: Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed :return: GetTransacSmsReport If the method is called asynchronously, returns the request thread. diff --git a/sib_api_v3_sdk/api_client.py b/sib_api_v3_sdk/api_client.py index c28b0eb..2254ae8 100644 --- a/sib_api_v3_sdk/api_client.py +++ b/sib_api_v3_sdk/api_client.py @@ -75,10 +75,10 @@ def __init__(self, configuration=None, header_name=None, header_value=None, elif header_name is not None and header_name != "User-Agent": self.default_headers[header_name] = header_value else: - self.user_agent = 'sendinblue_clientAPI/v7.1.0/python' + self.user_agent = 'sendinblue_clientAPI/v7.2.0/python' self.cookie = cookie # Set default User-Agent. - # self.user_agent = 'sendinblue_clientAPI/v7.0.0/python' + # self.user_agent = 'sendinblue_clientAPI/v7.2.0/python' def __del__(self): if self._pool is not None: diff --git a/sib_api_v3_sdk/models/__init__.py b/sib_api_v3_sdk/models/__init__.py index 155ad13..ef4420d 100644 --- a/sib_api_v3_sdk/models/__init__.py +++ b/sib_api_v3_sdk/models/__init__.py @@ -24,6 +24,7 @@ from sib_api_v3_sdk.models.add_child_domain import AddChildDomain from sib_api_v3_sdk.models.add_contact_to_list import AddContactToList from sib_api_v3_sdk.models.add_credits import AddCredits +from sib_api_v3_sdk.models.block_domain import BlockDomain from sib_api_v3_sdk.models.create_attribute import CreateAttribute from sib_api_v3_sdk.models.create_attribute_enumeration import CreateAttributeEnumeration from sib_api_v3_sdk.models.create_child import CreateChild @@ -58,6 +59,7 @@ from sib_api_v3_sdk.models.get_attributes import GetAttributes from sib_api_v3_sdk.models.get_attributes_attributes import GetAttributesAttributes from sib_api_v3_sdk.models.get_attributes_enumeration import GetAttributesEnumeration +from sib_api_v3_sdk.models.get_blocked_domains import GetBlockedDomains from sib_api_v3_sdk.models.get_campaign_overview import GetCampaignOverview from sib_api_v3_sdk.models.get_campaign_recipients import GetCampaignRecipients from sib_api_v3_sdk.models.get_campaign_stats import GetCampaignStats @@ -159,9 +161,12 @@ from sib_api_v3_sdk.models.send_smtp_email_attachment import SendSmtpEmailAttachment from sib_api_v3_sdk.models.send_smtp_email_bcc import SendSmtpEmailBcc from sib_api_v3_sdk.models.send_smtp_email_cc import SendSmtpEmailCc +from sib_api_v3_sdk.models.send_smtp_email_message_versions import SendSmtpEmailMessageVersions from sib_api_v3_sdk.models.send_smtp_email_reply_to import SendSmtpEmailReplyTo +from sib_api_v3_sdk.models.send_smtp_email_reply_to1 import SendSmtpEmailReplyTo1 from sib_api_v3_sdk.models.send_smtp_email_sender import SendSmtpEmailSender from sib_api_v3_sdk.models.send_smtp_email_to import SendSmtpEmailTo +from sib_api_v3_sdk.models.send_smtp_email_to1 import SendSmtpEmailTo1 from sib_api_v3_sdk.models.send_template_email import SendTemplateEmail from sib_api_v3_sdk.models.send_test_email import SendTestEmail from sib_api_v3_sdk.models.send_test_sms import SendTestSms diff --git a/sib_api_v3_sdk/models/create_smtp_email.py b/sib_api_v3_sdk/models/create_smtp_email.py index de06da4..95d0832 100644 --- a/sib_api_v3_sdk/models/create_smtp_email.py +++ b/sib_api_v3_sdk/models/create_smtp_email.py @@ -31,20 +31,26 @@ class CreateSmtpEmail(object): and the value is json key in definition. """ swagger_types = { - 'message_id': 'str' + 'message_id': 'str', + 'message_ids': 'list[str]' } attribute_map = { - 'message_id': 'messageId' + 'message_id': 'messageId', + 'message_ids': 'messageIds' } - def __init__(self, message_id=None): # noqa: E501 + def __init__(self, message_id=None, message_ids=None): # noqa: E501 """CreateSmtpEmail - a model defined in Swagger""" # noqa: E501 self._message_id = None + self._message_ids = None self.discriminator = None - self.message_id = message_id + if message_id is not None: + self.message_id = message_id + if message_ids is not None: + self.message_ids = message_ids @property def message_id(self): @@ -66,11 +72,30 @@ def message_id(self, message_id): :param message_id: The message_id of this CreateSmtpEmail. # noqa: E501 :type: str """ - if message_id is None: - raise ValueError("Invalid value for `message_id`, must not be `None`") # noqa: E501 self._message_id = message_id + @property + def message_ids(self): + """Gets the message_ids of this CreateSmtpEmail. # noqa: E501 + + + :return: The message_ids of this CreateSmtpEmail. # noqa: E501 + :rtype: list[str] + """ + return self._message_ids + + @message_ids.setter + def message_ids(self, message_ids): + """Sets the message_ids of this CreateSmtpEmail. + + + :param message_ids: The message_ids of this CreateSmtpEmail. # noqa: E501 + :type: list[str] + """ + + self._message_ids = message_ids + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/sib_api_v3_sdk/models/get_email_event_report_events.py b/sib_api_v3_sdk/models/get_email_event_report_events.py index f43d527..6635201 100644 --- a/sib_api_v3_sdk/models/get_email_event_report_events.py +++ b/sib_api_v3_sdk/models/get_email_event_report_events.py @@ -213,7 +213,7 @@ def event(self, event): """ if event is None: raise ValueError("Invalid value for `event`, must not be `None`") # noqa: E501 - allowed_values = ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed"] # noqa: E501 + allowed_values = ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked", "unsubscribed", "error"] # noqa: E501 if event not in allowed_values: raise ValueError( "Invalid value for `event` ({0}), must be one of {1}" # noqa: E501 diff --git a/sib_api_v3_sdk/models/send_smtp_email.py b/sib_api_v3_sdk/models/send_smtp_email.py index 3f0bcef..188e8c7 100644 --- a/sib_api_v3_sdk/models/send_smtp_email.py +++ b/sib_api_v3_sdk/models/send_smtp_email.py @@ -43,6 +43,7 @@ class SendSmtpEmail(object): 'headers': 'object', 'template_id': 'int', 'params': 'object', + 'message_versions': 'list[SendSmtpEmailMessageVersions]', 'tags': 'list[str]' } @@ -59,10 +60,11 @@ class SendSmtpEmail(object): 'headers': 'headers', 'template_id': 'templateId', 'params': 'params', + 'message_versions': 'messageVersions', 'tags': 'tags' } - def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, tags=None): # noqa: E501 + def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, text_content=None, subject=None, reply_to=None, attachment=None, headers=None, template_id=None, params=None, message_versions=None, tags=None): # noqa: E501 """SendSmtpEmail - a model defined in Swagger""" # noqa: E501 self._sender = None @@ -77,12 +79,14 @@ def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, t self._headers = None self._template_id = None self._params = None + self._message_versions = None self._tags = None self.discriminator = None if sender is not None: self.sender = sender - self.to = to + if to is not None: + self.to = to if bcc is not None: self.bcc = bcc if cc is not None: @@ -103,6 +107,8 @@ def __init__(self, sender=None, to=None, bcc=None, cc=None, html_content=None, t self.template_id = template_id if params is not None: self.params = params + if message_versions is not None: + self.message_versions = message_versions if tags is not None: self.tags = tags @@ -131,7 +137,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 + Mandatory if messageVersions are not passed, ignored if messageVersions are passed. 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] @@ -142,13 +148,11 @@ 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 + Mandatory if messageVersions are not passed, ignored if messageVersions are passed. 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] """ - if to is None: - raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501 self._to = to @@ -338,7 +342,7 @@ def headers(self, headers): def template_id(self): """Gets the template_id of this SendSmtpEmail. # noqa: E501 - Id of the template # noqa: E501 + Id of the template. Mandatory if messageVersions are passed # noqa: E501 :return: The template_id of this SendSmtpEmail. # noqa: E501 :rtype: int @@ -349,7 +353,7 @@ def template_id(self): def template_id(self, template_id): """Sets the template_id of this SendSmtpEmail. - Id of the template # noqa: E501 + Id of the template. Mandatory if messageVersions are passed # noqa: E501 :param template_id: The template_id of this SendSmtpEmail. # noqa: E501 :type: int @@ -380,6 +384,29 @@ def params(self, params): self._params = params + @property + def message_versions(self): + """Gets the message_versions of this SendSmtpEmail. # noqa: E501 + + You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails # noqa: E501 + + :return: The message_versions of this SendSmtpEmail. # noqa: E501 + :rtype: list[SendSmtpEmailMessageVersions] + """ + return self._message_versions + + @message_versions.setter + def message_versions(self, message_versions): + """Sets the message_versions of this SendSmtpEmail. + + You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails # noqa: E501 + + :param message_versions: The message_versions of this SendSmtpEmail. # noqa: E501 + :type: list[SendSmtpEmailMessageVersions] + """ + + self._message_versions = message_versions + @property def tags(self): """Gets the tags of this SendSmtpEmail. # noqa: E501 diff --git a/sib_api_v3_sdk/models/send_smtp_email_message_versions.py b/sib_api_v3_sdk/models/send_smtp_email_message_versions.py new file mode 100644 index 0000000..21fe012 --- /dev/null +++ b/sib_api_v3_sdk/models/send_smtp_email_message_versions.py @@ -0,0 +1,256 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class SendSmtpEmailMessageVersions(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'to': 'list[SendSmtpEmailTo1]', + 'params': 'dict(str, object)', + 'bcc': 'list[SendSmtpEmailBcc]', + 'cc': 'list[SendSmtpEmailCc]', + 'reply_to': 'SendSmtpEmailReplyTo1', + 'subject': 'str' + } + + attribute_map = { + 'to': 'to', + 'params': 'params', + 'bcc': 'bcc', + 'cc': 'cc', + 'reply_to': 'replyTo', + 'subject': 'subject' + } + + def __init__(self, to=None, params=None, bcc=None, cc=None, reply_to=None, subject=None): # noqa: E501 + """SendSmtpEmailMessageVersions - a model defined in Swagger""" # noqa: E501 + + self._to = None + self._params = None + self._bcc = None + self._cc = None + self._reply_to = None + self._subject = None + self.discriminator = None + + self.to = to + if params is not None: + self.params = params + if bcc is not None: + self.bcc = bcc + if cc is not None: + self.cc = cc + if reply_to is not None: + self.reply_to = reply_to + if subject is not None: + self.subject = subject + + @property + def to(self): + """Gets the to of this SendSmtpEmailMessageVersions. # 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 SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: list[SendSmtpEmailTo1] + """ + return self._to + + @to.setter + def to(self, to): + """Sets the to of this SendSmtpEmailMessageVersions. + + 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 SendSmtpEmailMessageVersions. # noqa: E501 + :type: list[SendSmtpEmailTo1] + """ + if to is None: + raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501 + + self._to = to + + @property + def params(self): + """Gets the params of this SendSmtpEmailMessageVersions. # 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 SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: dict(str, object) + """ + return self._params + + @params.setter + def params(self, params): + """Sets the params of this SendSmtpEmailMessageVersions. + + 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 SendSmtpEmailMessageVersions. # noqa: E501 + :type: dict(str, object) + """ + + self._params = params + + @property + def bcc(self): + """Gets the bcc of this SendSmtpEmailMessageVersions. # noqa: E501 + + List of email addresses and names (optional) of the recipients in bcc # noqa: E501 + + :return: The bcc of this SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: list[SendSmtpEmailBcc] + """ + return self._bcc + + @bcc.setter + def bcc(self, bcc): + """Sets the bcc of this SendSmtpEmailMessageVersions. + + List of email addresses and names (optional) of the recipients in bcc # noqa: E501 + + :param bcc: The bcc of this SendSmtpEmailMessageVersions. # noqa: E501 + :type: list[SendSmtpEmailBcc] + """ + + self._bcc = bcc + + @property + def cc(self): + """Gets the cc of this SendSmtpEmailMessageVersions. # noqa: E501 + + List of email addresses and names (optional) of the recipients in cc # noqa: E501 + + :return: The cc of this SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: list[SendSmtpEmailCc] + """ + return self._cc + + @cc.setter + def cc(self, cc): + """Sets the cc of this SendSmtpEmailMessageVersions. + + List of email addresses and names (optional) of the recipients in cc # noqa: E501 + + :param cc: The cc of this SendSmtpEmailMessageVersions. # noqa: E501 + :type: list[SendSmtpEmailCc] + """ + + self._cc = cc + + @property + def reply_to(self): + """Gets the reply_to of this SendSmtpEmailMessageVersions. # noqa: E501 + + + :return: The reply_to of this SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: SendSmtpEmailReplyTo1 + """ + return self._reply_to + + @reply_to.setter + def reply_to(self, reply_to): + """Sets the reply_to of this SendSmtpEmailMessageVersions. + + + :param reply_to: The reply_to of this SendSmtpEmailMessageVersions. # noqa: E501 + :type: SendSmtpEmailReplyTo1 + """ + + self._reply_to = reply_to + + @property + def subject(self): + """Gets the subject of this SendSmtpEmailMessageVersions. # noqa: E501 + + Custom subject specific to message version # noqa: E501 + + :return: The subject of this SendSmtpEmailMessageVersions. # noqa: E501 + :rtype: str + """ + return self._subject + + @subject.setter + def subject(self, subject): + """Sets the subject of this SendSmtpEmailMessageVersions. + + Custom subject specific to message version # noqa: E501 + + :param subject: The subject of this SendSmtpEmailMessageVersions. # noqa: E501 + :type: str + """ + + self._subject = subject + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SendSmtpEmailMessageVersions, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SendSmtpEmailMessageVersions): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/send_smtp_email_reply_to1.py b/sib_api_v3_sdk/models/send_smtp_email_reply_to1.py new file mode 100644 index 0000000..374bcbe --- /dev/null +++ b/sib_api_v3_sdk/models/send_smtp_email_reply_to1.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class SendSmtpEmailReplyTo1(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'email': 'str', + 'name': 'str' + } + + attribute_map = { + 'email': 'email', + 'name': 'name' + } + + def __init__(self, email=None, name=None): # noqa: E501 + """SendSmtpEmailReplyTo1 - a model defined in Swagger""" # noqa: E501 + + self._email = None + self._name = None + self.discriminator = None + + self.email = email + if name is not None: + self.name = name + + @property + def email(self): + """Gets the email of this SendSmtpEmailReplyTo1. # noqa: E501 + + Email address in reply to # noqa: E501 + + :return: The email of this SendSmtpEmailReplyTo1. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this SendSmtpEmailReplyTo1. + + Email address in reply to # noqa: E501 + + :param email: The email of this SendSmtpEmailReplyTo1. # noqa: E501 + :type: str + """ + if email is None: + raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501 + + self._email = email + + @property + def name(self): + """Gets the name of this SendSmtpEmailReplyTo1. # noqa: E501 + + Name in reply to. Maximum allowed characters are 70. # noqa: E501 + + :return: The name of this SendSmtpEmailReplyTo1. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this SendSmtpEmailReplyTo1. + + Name in reply to. Maximum allowed characters are 70. # noqa: E501 + + :param name: The name of this SendSmtpEmailReplyTo1. # noqa: E501 + :type: str + """ + + self._name = name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SendSmtpEmailReplyTo1, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SendSmtpEmailReplyTo1): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/sib_api_v3_sdk/models/send_smtp_email_to1.py b/sib_api_v3_sdk/models/send_smtp_email_to1.py new file mode 100644 index 0000000..776d0e5 --- /dev/null +++ b/sib_api_v3_sdk/models/send_smtp_email_to1.py @@ -0,0 +1,146 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +import pprint +import re # noqa: F401 + +import six + + +class SendSmtpEmailTo1(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'email': 'str', + 'name': 'str' + } + + attribute_map = { + 'email': 'email', + 'name': 'name' + } + + def __init__(self, email=None, name=None): # noqa: E501 + """SendSmtpEmailTo1 - a model defined in Swagger""" # noqa: E501 + + self._email = None + self._name = None + self.discriminator = None + + self.email = email + if name is not None: + self.name = name + + @property + def email(self): + """Gets the email of this SendSmtpEmailTo1. # noqa: E501 + + Email address of the recipient # noqa: E501 + + :return: The email of this SendSmtpEmailTo1. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this SendSmtpEmailTo1. + + Email address of the recipient # noqa: E501 + + :param email: The email of this SendSmtpEmailTo1. # noqa: E501 + :type: str + """ + if email is None: + raise ValueError("Invalid value for `email`, must not be `None`") # noqa: E501 + + self._email = email + + @property + def name(self): + """Gets the name of this SendSmtpEmailTo1. # noqa: E501 + + Name of the recipient. **Maximum allowed characters are 70**. # noqa: E501 + + :return: The name of this SendSmtpEmailTo1. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this SendSmtpEmailTo1. + + Name of the recipient. **Maximum allowed characters are 70**. # noqa: E501 + + :param name: The name of this SendSmtpEmailTo1. # noqa: E501 + :type: str + """ + + self._name = name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SendSmtpEmailTo1, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SendSmtpEmailTo1): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/test/test_send_smtp_email_message_versions.py b/test/test_send_smtp_email_message_versions.py new file mode 100644 index 0000000..5923a02 --- /dev/null +++ b/test/test_send_smtp_email_message_versions.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.send_smtp_email_message_versions import SendSmtpEmailMessageVersions # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestSendSmtpEmailMessageVersions(unittest.TestCase): + """SendSmtpEmailMessageVersions unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSendSmtpEmailMessageVersions(self): + """Test SendSmtpEmailMessageVersions""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.send_smtp_email_message_versions.SendSmtpEmailMessageVersions() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_send_smtp_email_reply_to1.py b/test/test_send_smtp_email_reply_to1.py new file mode 100644 index 0000000..a5c5174 --- /dev/null +++ b/test/test_send_smtp_email_reply_to1.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.send_smtp_email_reply_to1 import SendSmtpEmailReplyTo1 # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestSendSmtpEmailReplyTo1(unittest.TestCase): + """SendSmtpEmailReplyTo1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSendSmtpEmailReplyTo1(self): + """Test SendSmtpEmailReplyTo1""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.send_smtp_email_reply_to1.SendSmtpEmailReplyTo1() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_send_smtp_email_to1.py b/test/test_send_smtp_email_to1.py new file mode 100644 index 0000000..ccdfeb7 --- /dev/null +++ b/test/test_send_smtp_email_to1.py @@ -0,0 +1,40 @@ +# coding: utf-8 + +""" + SendinBlue API + + SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | # noqa: E501 + + OpenAPI spec version: 3.0.0 + Contact: contact@sendinblue.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + + +from __future__ import absolute_import + +import unittest + +import sib_api_v3_sdk +from sib_api_v3_sdk.models.send_smtp_email_to1 import SendSmtpEmailTo1 # noqa: E501 +from sib_api_v3_sdk.rest import ApiException + + +class TestSendSmtpEmailTo1(unittest.TestCase): + """SendSmtpEmailTo1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSendSmtpEmailTo1(self): + """Test SendSmtpEmailTo1""" + # FIXME: construct object with mandatory attributes with example values + # model = sib_api_v3_sdk.models.send_smtp_email_to1.SendSmtpEmailTo1() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_transactional_emails_api.py b/test/test_transactional_emails_api.py index fff08c8..b95dca0 100644 --- a/test/test_transactional_emails_api.py +++ b/test/test_transactional_emails_api.py @@ -29,6 +29,13 @@ def setUp(self): def tearDown(self): pass + def test_block_new_domain(self): + """Test case for block_new_domain + + Add a new domain to the list of blocked domains # noqa: E501 + """ + pass + def test_create_smtp_template(self): """Test case for create_smtp_template @@ -36,6 +43,13 @@ def test_create_smtp_template(self): """ pass + def test_delete_blocked_domain(self): + """Test case for delete_blocked_domain + + Unblock an existing domain from the list of blocked domains # noqa: E501 + """ + pass + def test_delete_hardbounces(self): """Test case for delete_hardbounces