Skip to content

Commit 1dd0877

Browse files
aakanksha-sibaakanksha-sib
committed
Swagger resync for new transactional email api endpoints
1 parent d8a884f commit 1dd0877

37 files changed

+1466
-84
lines changed

‎README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -169,18 +169,20 @@ Class | Method | HTTP request | Description
169169
*SMSCampaignsApi* | [**send_test_sms**](docs/SMSCampaignsApi.md#send_test_sms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS
170170
*SMSCampaignsApi* | [**update_sms_campaign**](docs/SMSCampaignsApi.md#update_sms_campaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign
171171
*SMSCampaignsApi* | [**update_sms_campaign_status**](docs/SMSCampaignsApi.md#update_sms_campaign_status) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status
172-
*SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create an smtp template
172+
*SMTPApi* | [**create_smtp_template**](docs/SMTPApi.md#create_smtp_template) | **POST** /smtp/templates | Create a transactional email template
173173
*SMTPApi* | [**delete_hardbounces**](docs/SMTPApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
174-
*SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template
175-
*SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your SMTP activity aggregated over a period of time
176-
*SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your SMTP activity (unaggregated events)
177-
*SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your SMTP activity aggregated per day
174+
*SMTPApi* | [**delete_smtp_template**](docs/SMTPApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive transactional email template
175+
*SMTPApi* | [**get_aggregated_smtp_report**](docs/SMTPApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
176+
*SMTPApi* | [**get_email_event_report**](docs/SMTPApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
177+
*SMTPApi* | [**get_smtp_report**](docs/SMTPApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
178178
*SMTPApi* | [**get_smtp_template**](docs/SMTPApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template informations
179-
*SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of SMTP templates
179+
*SMTPApi* | [**get_smtp_templates**](docs/SMTPApi.md#get_smtp_templates) | **GET** /smtp/templates | Get the list of transactional email templates
180+
*SMTPApi* | [**get_transac_email_content**](docs/SMTPApi.md#get_transac_email_content) | **GET** /smtp/emails/{uuid} | Get the personalized content of a sent transactional email
181+
*SMTPApi* | [**get_transac_emails_list**](docs/SMTPApi.md#get_transac_emails_list) | **GET** /smtp/emails | Get the list of transactional emails on the basis of allowed filters
180182
*SMTPApi* | [**send_template**](docs/SMTPApi.md#send_template) | **POST** /smtp/templates/{templateId}/send | Send a template
181183
*SMTPApi* | [**send_test_template**](docs/SMTPApi.md#send_test_template) | **POST** /smtp/templates/{templateId}/sendTest | Send a template to your test list
182184
*SMTPApi* | [**send_transac_email**](docs/SMTPApi.md#send_transac_email) | **POST** /smtp/email | Send a transactional email
183-
*SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates an smtp templates
185+
*SMTPApi* | [**update_smtp_template**](docs/SMTPApi.md#update_smtp_template) | **PUT** /smtp/templates/{templateId} | Updates a transactional email templates
184186
*SendersApi* | [**create_sender**](docs/SendersApi.md#create_sender) | **POST** /senders | Create a new sender
185187
*SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{senderId} | Delete a sender
186188
*SendersApi* | [**get_ips**](docs/SendersApi.md#get_ips) | **GET** /senders/ips | Return all the dedicated IPs for your account
@@ -297,6 +299,10 @@ Class | Method | HTTP request | Description
297299
- [GetSsoToken](docs/GetSsoToken.md)
298300
- [GetStatsByDomain](docs/GetStatsByDomain.md)
299301
- [GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
302+
- [GetTransacEmailContent](docs/GetTransacEmailContent.md)
303+
- [GetTransacEmailContentEvents](docs/GetTransacEmailContentEvents.md)
304+
- [GetTransacEmailsList](docs/GetTransacEmailsList.md)
305+
- [GetTransacEmailsListTransactionalEmails](docs/GetTransacEmailsListTransactionalEmails.md)
300306
- [GetTransacSmsReport](docs/GetTransacSmsReport.md)
301307
- [GetTransacSmsReportReports](docs/GetTransacSmsReportReports.md)
302308
- [GetWebhook](docs/GetWebhook.md)

‎docs/CreateContact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**sms_blacklisted** | **bool** | Set this field to blacklist the contact for SMS (smsBlacklisted = true) | [optional]
1010
**list_ids** | **list[int]** | Ids of the lists to add the contact to | [optional]
1111
**update_enabled** | **bool** | Facilitate to update the existing contact in the same request (updateEnabled = true) | [optional] [default to False]
12-
**smtp_blacklist_sender** | **list[str]** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
12+
**smtp_blacklist_sender** | **list[str]** | transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional]
1313

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

‎docs/CreateEmailCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**name** | **str** | Name of the campaign |
99
**html_content** | **str** | Mandatory if htmlUrl and templateId are empty. Body of the message (HTML) | [optional]
1010
**html_url** | **str** | Mandatory if htmlContent and templateId are empty. Url to the message (HTML) | [optional]
11-
**template_id** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
11+
**template_id** | **int** | Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. | [optional]
1212
**scheduled_at** | **datetime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). | [optional]
1313
**subject** | **str** | Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true. | [optional]
1414
**reply_to** | **str** | Email on which the campaign recipients will be able to reply to | [optional]

‎docs/CreateSmtpEmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**message_id** | **str** | Message ID of the SMTP Email sent |
6+
**message_id** | **str** | Message ID of the transactional email sent |
77

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

‎docs/GetAccountRelay.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**enabled** | **bool** | Status of your SMTP Account (true=Enabled, false=Disabled) |
6+
**enabled** | **bool** | Status of your transactional email Account (true=Enabled, false=Disabled) |
77
**data** | [**GetAccountRelayData**](GetAccountRelayData.md) | |
88

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

‎docs/GetAccountRelayData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**user_name** | **str** | Email to use as login on SMTP |
6+
**user_name** | **str** | Email to use as login on transactional platform |
77
**relay** | **str** | URL of the SMTP Relay |
88
**port** | **int** | Port used for SMTP Relay |
99

‎docs/GetSmtpTemplates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**count** | **int** | Count of smtp templates | [optional]
6+
**count** | **int** | Count of transactional email templates | [optional]
77
**templates** | [**list[GetSmtpTemplateOverview]**](GetSmtpTemplateOverview.md) | | [optional]
88

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

‎docs/GetTransacEmailContent.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# GetTransacEmailContent
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**email** | **str** | Email address to which transactional email has been sent |
7+
**subject** | **str** | Subject of the sent email |
8+
**template_id** | **int** | Id of the template | [optional]
9+
**date** | **datetime** | Date on which transactional email was sent |
10+
**events** | [**list[GetTransacEmailContentEvents]**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
11+
**body** | **str** | Actual content of the transactional email that has been sent |
12+
**attachment_count** | **int** | Count of the attachments that were sent in the email |
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+
16+

‎docs/GetTransacEmailContentEvents.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetTransacEmailContentEvents
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **str** | Name of the event that occurred on the sent email |
7+
**time** | **datetime** | Time at which the event occurred |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/GetTransacEmailsList.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GetTransacEmailsList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**transactional_emails** | [**list[GetTransacEmailsListTransactionalEmails]**](GetTransacEmailsListTransactionalEmails.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/GetTransacEmailsListTransactionalEmails.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# GetTransacEmailsListTransactionalEmails
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**email** | **str** | Email address to which transactional email has been sent |
7+
**subject** | **str** | Subject of the sent email |
8+
**template_id** | **int** | Id of the template | [optional]
9+
**message_id** | **str** | Message Id of the sent email |
10+
**uuid** | **str** | Unique id of the email sent to a particular contact |
11+
**date** | **datetime** | Date on which transactional email was sent |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

0 commit comments

Comments
 (0)