From 631ea80ef4810230a8c9a9d6c57b139d80864d54 Mon Sep 17 00:00:00 2001 From: pedrovivaldi Date: Mon, 20 Nov 2023 10:18:19 -0300 Subject: [PATCH 1/3] Added scroll time to doc --- content/api/suppression-list.apib | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/api/suppression-list.apib b/content/api/suppression-list.apib index 1dfb3e22..f5fd363c 100644 --- a/content/api/suppression-list.apib +++ b/content/api/suppression-list.apib @@ -188,7 +188,7 @@ If you don't have subaccounts, you do not need to provide the `X-MSYS-SUBACCOUNT + Parameters + recipient: `rcpt@example.com` (string, required) - Recipient email address. + types: `transactional` (list, optional) - Types of suppressions to match in the search, i.e. entries that are `transactional` or `non_transactional`. - + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. + + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period + per_page (number, optional) - Maximum number of results to return per page. Must be between 1 and 10,000. + Default: 1000 + page (number, optional) - The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets. @@ -291,7 +291,7 @@ Perform a filtered search for entries in your suppression list. Returns an array + description (string, optional) - String to match in suppression descriptions. + description_strict (boolean, optional) - A complementary field to description. When set to true, will match the exact content in the search description, alternatively will fetch all combination of results in the description. + Default: false - + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. + + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period + per_page (number, optional) - Maximum number of results to return per page. Must be between 1 and 10,000. + Default: 1000 + page (number, optional) - The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets. From af990d6367935cb3cf451a07235e850e9cef4fc0 Mon Sep 17 00:00:00 2001 From: Pedro Henrique Cotta Vivaldi Date: Mon, 20 Nov 2023 11:39:03 -0300 Subject: [PATCH 2/3] Update content/api/suppression-list.apib MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Vinícius Giles --- content/api/suppression-list.apib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/suppression-list.apib b/content/api/suppression-list.apib index f5fd363c..12f080f9 100644 --- a/content/api/suppression-list.apib +++ b/content/api/suppression-list.apib @@ -188,7 +188,7 @@ If you don't have subaccounts, you do not need to provide the `X-MSYS-SUBACCOUNT + Parameters + recipient: `rcpt@example.com` (string, required) - Recipient email address. + types: `transactional` (list, optional) - Types of suppressions to match in the search, i.e. entries that are `transactional` or `non_transactional`. - + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period + + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period. + per_page (number, optional) - Maximum number of results to return per page. Must be between 1 and 10,000. + Default: 1000 + page (number, optional) - The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets. From 3bac9da191283a9730cb99cd2eb5ac43b6832d51 Mon Sep 17 00:00:00 2001 From: Pedro Henrique Cotta Vivaldi Date: Mon, 20 Nov 2023 11:39:09 -0300 Subject: [PATCH 3/3] Update content/api/suppression-list.apib MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Vinícius Giles --- content/api/suppression-list.apib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/api/suppression-list.apib b/content/api/suppression-list.apib index 12f080f9..6b97dc6e 100644 --- a/content/api/suppression-list.apib +++ b/content/api/suppression-list.apib @@ -291,7 +291,7 @@ Perform a filtered search for entries in your suppression list. Returns an array + description (string, optional) - String to match in suppression descriptions. + description_strict (boolean, optional) - A complementary field to description. When set to true, will match the exact content in the search description, alternatively will fetch all combination of results in the description. + Default: false - + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period + + cursor (string, optional) - The results cursor location to return, to start paging with cursor, use the value of 'initial'. When cursor is provided the `page` parameter is ignored. Cursors last 15 minutes, create a new one after this period. + per_page (number, optional) - Maximum number of results to return per page. Must be between 1 and 10,000. + Default: 1000 + page (number, optional) - The results page number to return. Used with `per_page` for paging through results. Works up to 10,000 results. Use the `cursor` parameter to page larger result sets.