From b6ca4bd513190d7b1af48e24cee69340a6158ebd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 14:54:39 +0000 Subject: [PATCH] feat(api): api update (#2149) --- .stats.yml | 2 +- .../resources/email_security/investigate.py | 80 +++++++++---------- .../email_security/settings/allow_patterns.py | 12 +-- .../email_security/settings/block_senders.py | 8 +- .../email_security/settings/domains.py | 30 ++++--- .../settings/impersonation_registry.py | 12 +-- .../settings/trusted_domains.py | 12 +-- .../investigate_detections_response.py | 4 +- .../investigate_get_response.py | 2 +- .../email_security/investigate_list_params.py | 16 ++-- .../investigate_list_response.py | 2 +- .../investigate_preview_response.py | 2 +- .../investigate_raw_response.py | 2 +- .../settings/allow_pattern_list_params.py | 4 +- .../settings/block_sender_list_params.py | 4 +- .../settings/domain_delete_response.py | 2 +- .../settings/domain_edit_response.py | 2 +- .../settings/domain_list_params.py | 11 +-- .../settings/domain_list_response.py | 2 +- .../impersonation_registry_list_params.py | 4 +- .../settings/trusted_domain_list_params.py | 4 +- 21 files changed, 104 insertions(+), 113 deletions(-) diff --git a/.stats.yml b/.stats.yml index 3c566613221..b2e3dd73b7a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 1417 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-238bdc2301e165198e92ece05a86c3b80aa6653c5cd7334b3dc59fd9d687acce.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-1c64fbec9a1e17ca560abf251c26a4adb4d60123dbe3f7dcc10819494cd97a6f.yml diff --git a/src/cloudflare/resources/email_security/investigate.py b/src/cloudflare/resources/email_security/investigate.py index f1e56756fb0..00bd691377e 100644 --- a/src/cloudflare/resources/email_security/investigate.py +++ b/src/cloudflare/resources/email_security/investigate.py @@ -79,29 +79,28 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePaginationArray[InvestigateListResponse]: """ - This endpoint returns information for each email that matches the search - parameter(s). + Returns information for each email that matches the search parameter(s). Args: account_id: Account Identifier - action_log: Controls whether the message action log in included in the response. + action_log: Determines if the message action log is included in the response. - detections_only: If `false`, the search includes non-detections. + detections_only: Determines if the search results will include detections or not. - domain: Filter by the sender domain + domain: The sender domains the search filters by. end: The end of the search date range. Defaults to `now`. - final_disposition: Filter messages by the provided disposition. + final_disposition: The dispositions the search filters by. - message_action: Filter messages by actions applied to them + message_action: The message actions the search filters by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. - query: Space delimited query term(s). The search is case-insensitive. + query: The space-delimited term used in the query. The search is case-insensitive. The content of the following email metadata fields are searched: @@ -183,13 +182,13 @@ def detections( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigateDetectionsResponse: """ - For emails that have a detection, this endpoint returns detection details such - as threat categories, sender information, and links. + Returns detection details such as threat categories and sender information for + non-benign messages. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -233,7 +232,7 @@ def get( Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -272,13 +271,13 @@ def preview( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigatePreviewResponse: """ - For emails that have a detection, this endpoint returns a preview of the message - body as a base64 encoded PNG image. + Returns a preview of the message body as a base64 encoded PNG image for + non-benign messages. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -317,13 +316,12 @@ def raw( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigateRawResponse: """ - For emails that have a detection, this endpoint returns the raw email as an EML - file. + Returns the raw eml of any non-benign message. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -367,7 +365,7 @@ def trace( Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -441,29 +439,28 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[InvestigateListResponse, AsyncV4PagePaginationArray[InvestigateListResponse]]: """ - This endpoint returns information for each email that matches the search - parameter(s). + Returns information for each email that matches the search parameter(s). Args: account_id: Account Identifier - action_log: Controls whether the message action log in included in the response. + action_log: Determines if the message action log is included in the response. - detections_only: If `false`, the search includes non-detections. + detections_only: Determines if the search results will include detections or not. - domain: Filter by the sender domain + domain: The sender domains the search filters by. end: The end of the search date range. Defaults to `now`. - final_disposition: Filter messages by the provided disposition. + final_disposition: The dispositions the search filters by. - message_action: Filter messages by actions applied to them + message_action: The message actions the search filters by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. - query: Space delimited query term(s). The search is case-insensitive. + query: The space-delimited term used in the query. The search is case-insensitive. The content of the following email metadata fields are searched: @@ -545,13 +542,13 @@ async def detections( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigateDetectionsResponse: """ - For emails that have a detection, this endpoint returns detection details such - as threat categories, sender information, and links. + Returns detection details such as threat categories and sender information for + non-benign messages. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -595,7 +592,7 @@ async def get( Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -634,13 +631,13 @@ async def preview( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigatePreviewResponse: """ - For emails that have a detection, this endpoint returns a preview of the message - body as a base64 encoded PNG image. + Returns a preview of the message body as a base64 encoded PNG image for + non-benign messages. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -679,13 +676,12 @@ async def raw( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InvestigateRawResponse: """ - For emails that have a detection, this endpoint returns the raw email as an EML - file. + Returns the raw eml of any non-benign message. Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers @@ -729,7 +725,7 @@ async def trace( Args: account_id: Account Identifier - postfix_id: Message identifier + postfix_id: The identifier of the message. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/email_security/settings/allow_patterns.py b/src/cloudflare/resources/email_security/settings/allow_patterns.py index a4f850e75ad..4c7ef5913f9 100644 --- a/src/cloudflare/resources/email_security/settings/allow_patterns.py +++ b/src/cloudflare/resources/email_security/settings/allow_patterns.py @@ -202,7 +202,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePaginationArray[AllowPatternListResponse]: """ - List, search, and sort an accounts's email allow patterns. + Lists, searches, and sorts an account’s email allow patterns. Args: account_id: Account Identifier @@ -211,9 +211,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -562,7 +562,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[AllowPatternListResponse, AsyncV4PagePaginationArray[AllowPatternListResponse]]: """ - List, search, and sort an accounts's email allow patterns. + Lists, searches, and sorts an account’s email allow patterns. Args: account_id: Account Identifier @@ -571,9 +571,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is diff --git a/src/cloudflare/resources/email_security/settings/block_senders.py b/src/cloudflare/resources/email_security/settings/block_senders.py index e9c1788bb5e..41d3e4cfd67 100644 --- a/src/cloudflare/resources/email_security/settings/block_senders.py +++ b/src/cloudflare/resources/email_security/settings/block_senders.py @@ -192,9 +192,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -521,9 +521,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is diff --git a/src/cloudflare/resources/email_security/settings/domains.py b/src/cloudflare/resources/email_security/settings/domains.py index 80ec9e3f144..79101bdfe36 100644 --- a/src/cloudflare/resources/email_security/settings/domains.py +++ b/src/cloudflare/resources/email_security/settings/domains.py @@ -70,23 +70,22 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePaginationArray[DomainListResponse]: """ - List, search, and sort an account's email domains. + Lists, searches, and sorts an account’s email domains. Args: account_id: Account Identifier - allowed_delivery_mode: If present, the response contains only domains with the provided delivery mode. + allowed_delivery_mode: Filters response to domains with the provided delivery mode. direction: The sorting direction. - domain: Filter result by the provided domains. Allows for multiple occurrences, e.g., - `domain=example.com&domain=example.xyz`. + domain: Filters results by the provided domains, allowing for multiple occurrences. order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -144,7 +143,7 @@ def delete( Args: account_id: Account Identifier - domain_id: Unique domain identifier + domain_id: The unique identifier for the domain. extra_headers: Send extra headers @@ -189,7 +188,7 @@ def edit( Args: account_id: Account Identifier - domain_id: Unique domain identifier + domain_id: The unique identifier for the domain. extra_headers: Send extra headers @@ -261,23 +260,22 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[DomainListResponse, AsyncV4PagePaginationArray[DomainListResponse]]: """ - List, search, and sort an account's email domains. + Lists, searches, and sorts an account’s email domains. Args: account_id: Account Identifier - allowed_delivery_mode: If present, the response contains only domains with the provided delivery mode. + allowed_delivery_mode: Filters response to domains with the provided delivery mode. direction: The sorting direction. - domain: Filter result by the provided domains. Allows for multiple occurrences, e.g., - `domain=example.com&domain=example.xyz`. + domain: Filters results by the provided domains, allowing for multiple occurrences. order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -335,7 +333,7 @@ async def delete( Args: account_id: Account Identifier - domain_id: Unique domain identifier + domain_id: The unique identifier for the domain. extra_headers: Send extra headers @@ -380,7 +378,7 @@ async def edit( Args: account_id: Account Identifier - domain_id: Unique domain identifier + domain_id: The unique identifier for the domain. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/email_security/settings/impersonation_registry.py b/src/cloudflare/resources/email_security/settings/impersonation_registry.py index 669c5fdc248..bb67428ecff 100644 --- a/src/cloudflare/resources/email_security/settings/impersonation_registry.py +++ b/src/cloudflare/resources/email_security/settings/impersonation_registry.py @@ -181,7 +181,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePaginationArray[ImpersonationRegistryListResponse]: """ - List, search, and sort entries in impersonation registry. + Lists, searches, and sorts entries in the impersonation registry. Args: account_id: Account Identifier @@ -190,9 +190,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -508,7 +508,7 @@ def list( ImpersonationRegistryListResponse, AsyncV4PagePaginationArray[ImpersonationRegistryListResponse] ]: """ - List, search, and sort entries in impersonation registry. + Lists, searches, and sorts entries in the impersonation registry. Args: account_id: Account Identifier @@ -517,9 +517,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is diff --git a/src/cloudflare/resources/email_security/settings/trusted_domains.py b/src/cloudflare/resources/email_security/settings/trusted_domains.py index 4fdaa9777ca..a1010084b41 100644 --- a/src/cloudflare/resources/email_security/settings/trusted_domains.py +++ b/src/cloudflare/resources/email_security/settings/trusted_domains.py @@ -187,7 +187,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePaginationArray[TrustedDomainListResponse]: """ - List, search, and sort an account's trusted email domains. + Lists, searches, and sorts an account’s trusted email domains. Args: account_id: Account Identifier @@ -196,9 +196,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is @@ -523,7 +523,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[TrustedDomainListResponse, AsyncV4PagePaginationArray[TrustedDomainListResponse]]: """ - List, search, and sort an account's trusted email domains. + Lists, searches, and sorts an account’s trusted email domains. Args: account_id: Account Identifier @@ -532,9 +532,9 @@ def list( order: The field to sort by. - page: Page number of paginated results. + page: The page number of paginated results. - per_page: Number of results to display. + per_page: The number of results per page. search: Allows searching in multiple properties of a record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is diff --git a/src/cloudflare/types/email_security/investigate_detections_response.py b/src/cloudflare/types/email_security/investigate_detections_response.py index 2adca67e408..aa55f2054d9 100644 --- a/src/cloudflare/types/email_security/investigate_detections_response.py +++ b/src/cloudflare/types/email_security/investigate_detections_response.py @@ -55,10 +55,10 @@ class Link(BaseModel): class SenderInfo(BaseModel): as_name: Optional[str] = None - """Name of the autonomous system""" + """The name of the autonomous system.""" as_number: Optional[int] = None - """Number of the autonomous system""" + """The number of the autonomous system.""" geo: Optional[str] = None diff --git a/src/cloudflare/types/email_security/investigate_get_response.py b/src/cloudflare/types/email_security/investigate_get_response.py index e8b179081f3..43a2cae09b4 100644 --- a/src/cloudflare/types/email_security/investigate_get_response.py +++ b/src/cloudflare/types/email_security/investigate_get_response.py @@ -34,7 +34,7 @@ class InvestigateGetResponse(BaseModel): is_quarantined: bool postfix_id: str - """Message identifier""" + """The identifier of the message.""" ts: str diff --git a/src/cloudflare/types/email_security/investigate_list_params.py b/src/cloudflare/types/email_security/investigate_list_params.py index 4b075e87d9f..a137f2498b8 100644 --- a/src/cloudflare/types/email_security/investigate_list_params.py +++ b/src/cloudflare/types/email_security/investigate_list_params.py @@ -16,37 +16,37 @@ class InvestigateListParams(TypedDict, total=False): """Account Identifier""" action_log: bool - """Controls whether the message action log in included in the response.""" + """Determines if the message action log is included in the response.""" alert_id: str detections_only: bool - """If `false`, the search includes non-detections.""" + """Determines if the search results will include detections or not.""" domain: str - """Filter by the sender domain""" + """The sender domains the search filters by.""" end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")] """The end of the search date range. Defaults to `now`.""" final_disposition: Literal["MALICIOUS", "SUSPICIOUS", "SPOOF", "SPAM", "BULK"] - """Filter messages by the provided disposition.""" + """The dispositions the search filters by.""" message_action: Literal["PREVIEW", "QUARANTINE_RELEASED", "MOVED"] - """Filter messages by actions applied to them""" + """The message actions the search filters by.""" message_id: str metric: str page: int - """Page number of paginated results.""" + """The page number of paginated results.""" per_page: int - """Number of results to display.""" + """The number of results per page.""" query: str - """Space delimited query term(s). The search is case-insensitive. + """The space-delimited term used in the query. The search is case-insensitive. The content of the following email metadata fields are searched: diff --git a/src/cloudflare/types/email_security/investigate_list_response.py b/src/cloudflare/types/email_security/investigate_list_response.py index 9d3820b0ea4..78004ee0fd5 100644 --- a/src/cloudflare/types/email_security/investigate_list_response.py +++ b/src/cloudflare/types/email_security/investigate_list_response.py @@ -34,7 +34,7 @@ class InvestigateListResponse(BaseModel): is_quarantined: bool postfix_id: str - """Message identifier""" + """The identifier of the message.""" ts: str diff --git a/src/cloudflare/types/email_security/investigate_preview_response.py b/src/cloudflare/types/email_security/investigate_preview_response.py index 70b13bdcb57..a751b9ef3ac 100644 --- a/src/cloudflare/types/email_security/investigate_preview_response.py +++ b/src/cloudflare/types/email_security/investigate_preview_response.py @@ -8,4 +8,4 @@ class InvestigatePreviewResponse(BaseModel): screenshot: str - """Base64 encoded PNG image""" + """A base64 encoded PNG image of the email.""" diff --git a/src/cloudflare/types/email_security/investigate_raw_response.py b/src/cloudflare/types/email_security/investigate_raw_response.py index ce73a713134..341b44b0137 100644 --- a/src/cloudflare/types/email_security/investigate_raw_response.py +++ b/src/cloudflare/types/email_security/investigate_raw_response.py @@ -8,4 +8,4 @@ class InvestigateRawResponse(BaseModel): raw: str - """UTF-8 encoded eml file""" + """A UTF-8 encoded eml file of the email.""" diff --git a/src/cloudflare/types/email_security/settings/allow_pattern_list_params.py b/src/cloudflare/types/email_security/settings/allow_pattern_list_params.py index 13cea6cb81a..bd24e235c1d 100644 --- a/src/cloudflare/types/email_security/settings/allow_pattern_list_params.py +++ b/src/cloudflare/types/email_security/settings/allow_pattern_list_params.py @@ -24,12 +24,12 @@ class AllowPatternListParams(TypedDict, total=False): """The field to sort by.""" page: int - """Page number of paginated results.""" + """The page number of paginated results.""" pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"] per_page: int - """Number of results to display.""" + """The number of results per page.""" search: str """ diff --git a/src/cloudflare/types/email_security/settings/block_sender_list_params.py b/src/cloudflare/types/email_security/settings/block_sender_list_params.py index 01139d96df8..714e6955316 100644 --- a/src/cloudflare/types/email_security/settings/block_sender_list_params.py +++ b/src/cloudflare/types/email_security/settings/block_sender_list_params.py @@ -18,12 +18,12 @@ class BlockSenderListParams(TypedDict, total=False): """The field to sort by.""" page: int - """Page number of paginated results.""" + """The page number of paginated results.""" pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"] per_page: int - """Number of results to display.""" + """The number of results per page.""" search: str """ diff --git a/src/cloudflare/types/email_security/settings/domain_delete_response.py b/src/cloudflare/types/email_security/settings/domain_delete_response.py index a43a63552b2..64c0e84d53d 100644 --- a/src/cloudflare/types/email_security/settings/domain_delete_response.py +++ b/src/cloudflare/types/email_security/settings/domain_delete_response.py @@ -8,4 +8,4 @@ class DomainDeleteResponse(BaseModel): id: int - """Unique domain identifier""" + """The unique identifier for the domain.""" diff --git a/src/cloudflare/types/email_security/settings/domain_edit_response.py b/src/cloudflare/types/email_security/settings/domain_edit_response.py index 31b8516678f..4983a5f6d2a 100644 --- a/src/cloudflare/types/email_security/settings/domain_edit_response.py +++ b/src/cloudflare/types/email_security/settings/domain_edit_response.py @@ -11,7 +11,7 @@ class DomainEditResponse(BaseModel): id: int - """Unique domain identifier""" + """The unique identifier for the domain.""" allowed_delivery_modes: List[Literal["DIRECT", "BCC", "JOURNAL", "API", "RETRO_SCAN"]] diff --git a/src/cloudflare/types/email_security/settings/domain_list_params.py b/src/cloudflare/types/email_security/settings/domain_list_params.py index f6f46184fc6..c6b3345325d 100644 --- a/src/cloudflare/types/email_security/settings/domain_list_params.py +++ b/src/cloudflare/types/email_security/settings/domain_list_params.py @@ -13,25 +13,22 @@ class DomainListParams(TypedDict, total=False): """Account Identifier""" allowed_delivery_mode: Literal["DIRECT", "BCC", "JOURNAL", "API", "RETRO_SCAN"] - """If present, the response contains only domains with the provided delivery mode.""" + """Filters response to domains with the provided delivery mode.""" direction: Literal["asc", "desc"] """The sorting direction.""" domain: List[str] - """ - Filter result by the provided domains. Allows for multiple occurrences, e.g., - `domain=example.com&domain=example.xyz`. - """ + """Filters results by the provided domains, allowing for multiple occurrences.""" order: Literal["domain", "created_at"] """The field to sort by.""" page: int - """Page number of paginated results.""" + """The page number of paginated results.""" per_page: int - """Number of results to display.""" + """The number of results per page.""" search: str """ diff --git a/src/cloudflare/types/email_security/settings/domain_list_response.py b/src/cloudflare/types/email_security/settings/domain_list_response.py index fe9208e6a40..22ecc8e3439 100644 --- a/src/cloudflare/types/email_security/settings/domain_list_response.py +++ b/src/cloudflare/types/email_security/settings/domain_list_response.py @@ -11,7 +11,7 @@ class DomainListResponse(BaseModel): id: int - """Unique domain identifier""" + """The unique identifier for the domain.""" allowed_delivery_modes: List[Literal["DIRECT", "BCC", "JOURNAL", "API", "RETRO_SCAN"]] diff --git a/src/cloudflare/types/email_security/settings/impersonation_registry_list_params.py b/src/cloudflare/types/email_security/settings/impersonation_registry_list_params.py index ed52d4c206a..49a2b1ddf0a 100644 --- a/src/cloudflare/types/email_security/settings/impersonation_registry_list_params.py +++ b/src/cloudflare/types/email_security/settings/impersonation_registry_list_params.py @@ -18,10 +18,10 @@ class ImpersonationRegistryListParams(TypedDict, total=False): """The field to sort by.""" page: int - """Page number of paginated results.""" + """The page number of paginated results.""" per_page: int - """Number of results to display.""" + """The number of results per page.""" provenance: Literal["A1S_INTERNAL", "SNOOPY-CASB_OFFICE_365", "SNOOPY-OFFICE_365", "SNOOPY-GOOGLE_DIRECTORY"] diff --git a/src/cloudflare/types/email_security/settings/trusted_domain_list_params.py b/src/cloudflare/types/email_security/settings/trusted_domain_list_params.py index d27d769cc51..a273ce83e95 100644 --- a/src/cloudflare/types/email_security/settings/trusted_domain_list_params.py +++ b/src/cloudflare/types/email_security/settings/trusted_domain_list_params.py @@ -22,10 +22,10 @@ class TrustedDomainListParams(TypedDict, total=False): """The field to sort by.""" page: int - """Page number of paginated results.""" + """The page number of paginated results.""" per_page: int - """Number of results to display.""" + """The number of results per page.""" search: str """