docs/TransactionalEmailsApi.md in sib-api-v3-sdk-7.2.0 vs docs/TransactionalEmailsApi.md in sib-api-v3-sdk-7.3.0

- old
+ new

@@ -464,11 +464,11 @@ email: 'email_example', # String | Filter the report for a specific email addresses event: 'event_example', # String | Filter the report for a specific event type tags: 'tags_example', # String | Filter the report for tags (serialized and urlencoded array) message_id: 'message_id_example', # String | Filter on a specific message id template_id: 789, # Integer | Filter on a specific template id - sort: 'desc' # String | Sort the results in the ascending/descending order of record creation + sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get all your transactional email activity (unaggregated events) result = api_instance.get_email_event_report(opts) @@ -490,11 +490,11 @@ **email** | **String**| Filter the report for a specific email addresses | [optional] **event** | **String**| Filter the report for a specific event type | [optional] **tags** | **String**| Filter the report for tags (serialized and urlencoded array) | [optional] **message_id** | **String**| Filter on a specific message id | [optional] **template_id** | **Integer**| Filter on a specific template id | [optional] - **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] ### Return type [**GetEmailEventReport**](GetEmailEventReport.md) @@ -538,11 +538,11 @@ offset: 0, # Integer | Index of the first document on the page start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' tag: 'tag_example', # String | Tag of the emails - sort: 'desc' # String | Sort the results in the ascending/descending order of record creation + sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get your transactional email activity aggregated per day result = api_instance.get_smtp_report(opts) @@ -560,11 +560,11 @@ **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0] **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional] **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional] **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with &#39;startDate&#39; and &#39;endDate&#39; | [optional] **tag** | **String**| Tag of the emails | [optional] - **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] ### Return type [**GetReports**](GetReports.md) @@ -662,11 +662,11 @@ opts = { template_status: true, # BOOLEAN | Filter on the status of the template. Active = true, inactive = false limit: 50, # Integer | Number of documents returned per page offset: 0, # Integer | Index of the first document in the page - sort: 'desc' # String | Sort the results in the ascending/descending order of record creation + sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get the list of email templates result = api_instance.get_smtp_templates(opts) @@ -681,11 +681,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **template_status** | **BOOLEAN**| Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false | [optional] **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50] **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0] - **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] ### Return type [**GetSmtpTemplates**](GetSmtpTemplates.md) @@ -728,11 +728,11 @@ start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts limit: 50, # Integer | Number of documents returned per page offset: 0, # Integer | Index of the first document on the page senders: ['senders_example'], # Array<String> | Comma separated list of emails of the senders from which contacts are blocked or unsubscribed - sort: 'desc' # String | Sort the results in the ascending/descending order of record creation + sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get the list of blocked or unsubscribed transactional contacts result = api_instance.get_transac_blocked_contacts(opts) @@ -749,11 +749,11 @@ **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts | [optional] **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts | [optional] **limit** | **Integer**| Number of documents returned per page | [optional] [default to 50] **offset** | **Integer**| Index of the first document on the page | [optional] [default to 0] **senders** | [**Array&lt;String&gt;**](String.md)| Comma separated list of emails of the senders from which contacts are blocked or unsubscribed | [optional] - **sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] ### Return type [**GetTransacBlockedContacts**](GetTransacBlockedContacts.md) @@ -855,11 +855,11 @@ email: 'email_example', # String | Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. template_id: 789, # Integer | Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. message_id: 'message_id_example', # String | Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. start_date: Date.parse('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. end_date: Date.parse('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. - sort: 'desc' # String | Sort the results in the ascending/descending order of record creation + sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed } begin #Get the list of transactional emails on the basis of allowed filters result = api_instance.get_transac_emails_list(opts) @@ -876,10 +876,10 @@ **email** | **String**| Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. | [optional] **template_id** | **Integer**| Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. | [optional] **message_id** | **String**| 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** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc] + **sort** | **String**| Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed | [optional] [default to desc] ### Return type [**GetTransacEmailsList**](GetTransacEmailsList.md)