|
| 1 | +from typing import Any, Dict, List, Optional, cast |
| 2 | + |
| 3 | +from typing_extensions import NotRequired, TypedDict |
| 4 | + |
| 5 | +from resend import request |
| 6 | +from resend._base_response import BaseResponse |
| 7 | +from resend.logs._log import Log |
| 8 | +from resend.pagination_helper import PaginationHelper |
| 9 | + |
| 10 | +# Async imports (optional - only available with pip install resend[async]) |
| 11 | +try: |
| 12 | + from resend.async_request import AsyncRequest |
| 13 | +except ImportError: |
| 14 | + pass |
| 15 | + |
| 16 | + |
| 17 | +class Logs: |
| 18 | + |
| 19 | + class GetResponse(BaseResponse): |
| 20 | + """ |
| 21 | + GetResponse type that wraps a single log object |
| 22 | +
|
| 23 | + Attributes: |
| 24 | + object (str): The object type, always "log" |
| 25 | + id (str): The log ID |
| 26 | + created_at (str): The date and time the log was created |
| 27 | + endpoint (str): The API endpoint that was called |
| 28 | + method (str): The HTTP method used |
| 29 | + response_status (int): The HTTP response status code |
| 30 | + user_agent (str): The user agent of the client |
| 31 | + request_body (Any): The original request body |
| 32 | + response_body (Any): The API response body |
| 33 | + """ |
| 34 | + |
| 35 | + object: str |
| 36 | + """ |
| 37 | + The object type, always "log" |
| 38 | + """ |
| 39 | + id: str |
| 40 | + """ |
| 41 | + The log ID |
| 42 | + """ |
| 43 | + created_at: str |
| 44 | + """ |
| 45 | + The date and time the log was created |
| 46 | + """ |
| 47 | + endpoint: str |
| 48 | + """ |
| 49 | + The API endpoint that was called |
| 50 | + """ |
| 51 | + method: str |
| 52 | + """ |
| 53 | + The HTTP method used |
| 54 | + """ |
| 55 | + response_status: int |
| 56 | + """ |
| 57 | + The HTTP response status code |
| 58 | + """ |
| 59 | + user_agent: str |
| 60 | + """ |
| 61 | + The user agent of the client |
| 62 | + """ |
| 63 | + request_body: Any |
| 64 | + """ |
| 65 | + The original request body |
| 66 | + """ |
| 67 | + response_body: Any |
| 68 | + """ |
| 69 | + The API response body |
| 70 | + """ |
| 71 | + |
| 72 | + class ListResponse(BaseResponse): |
| 73 | + """ |
| 74 | + ListResponse type that wraps a list of log objects with pagination metadata |
| 75 | +
|
| 76 | + Attributes: |
| 77 | + object (str): The object type, always "list" |
| 78 | + data (List[Log]): A list of log objects |
| 79 | + has_more (bool): Whether there are more results available |
| 80 | + """ |
| 81 | + |
| 82 | + object: str |
| 83 | + """ |
| 84 | + The object type, always "list" |
| 85 | + """ |
| 86 | + data: List[Log] |
| 87 | + """ |
| 88 | + A list of log objects |
| 89 | + """ |
| 90 | + has_more: bool |
| 91 | + """ |
| 92 | + Whether there are more results available for pagination |
| 93 | + """ |
| 94 | + |
| 95 | + class ListParams(TypedDict): |
| 96 | + limit: NotRequired[int] |
| 97 | + """ |
| 98 | + Number of logs to retrieve. Maximum is 100, and minimum is 1. |
| 99 | + """ |
| 100 | + after: NotRequired[str] |
| 101 | + """ |
| 102 | + The ID after which we'll retrieve more logs (for pagination). |
| 103 | + This ID will not be included in the returned list. |
| 104 | + Cannot be used with the before parameter. |
| 105 | + """ |
| 106 | + before: NotRequired[str] |
| 107 | + """ |
| 108 | + The ID before which we'll retrieve more logs (for pagination). |
| 109 | + This ID will not be included in the returned list. |
| 110 | + Cannot be used with the after parameter. |
| 111 | + """ |
| 112 | + |
| 113 | + @classmethod |
| 114 | + def get(cls, log_id: str) -> GetResponse: |
| 115 | + """ |
| 116 | + Retrieve a single log by its ID. |
| 117 | + see more: https://resend.com/docs/api-reference/logs/retrieve-log |
| 118 | +
|
| 119 | + Args: |
| 120 | + log_id (str): The ID of the log to retrieve |
| 121 | +
|
| 122 | + Returns: |
| 123 | + GetResponse: The log object |
| 124 | + """ |
| 125 | + path = f"/logs/{log_id}" |
| 126 | + resp = request.Request[Logs.GetResponse]( |
| 127 | + path=path, params={}, verb="get" |
| 128 | + ).perform_with_content() |
| 129 | + return resp |
| 130 | + |
| 131 | + @classmethod |
| 132 | + def list(cls, params: Optional[ListParams] = None) -> ListResponse: |
| 133 | + """ |
| 134 | + Retrieve a list of logs. |
| 135 | + see more: https://resend.com/docs/api-reference/logs/list-logs |
| 136 | +
|
| 137 | + Args: |
| 138 | + params (Optional[ListParams]): Optional pagination parameters |
| 139 | + - limit: Number of logs to retrieve (max 100, min 1) |
| 140 | + - after: ID after which to retrieve more logs |
| 141 | + - before: ID before which to retrieve more logs |
| 142 | +
|
| 143 | + Returns: |
| 144 | + ListResponse: A list of log objects |
| 145 | + """ |
| 146 | + base_path = "/logs" |
| 147 | + query_params = cast(Dict[Any, Any], params) if params else None |
| 148 | + path = PaginationHelper.build_paginated_path(base_path, query_params) |
| 149 | + resp = request.Request[Logs.ListResponse]( |
| 150 | + path=path, params={}, verb="get" |
| 151 | + ).perform_with_content() |
| 152 | + return resp |
| 153 | + |
| 154 | + @classmethod |
| 155 | + async def get_async(cls, log_id: str) -> GetResponse: |
| 156 | + """ |
| 157 | + Retrieve a single log by its ID (async). |
| 158 | + see more: https://resend.com/docs/api-reference/logs/retrieve-log |
| 159 | +
|
| 160 | + Args: |
| 161 | + log_id (str): The ID of the log to retrieve |
| 162 | +
|
| 163 | + Returns: |
| 164 | + GetResponse: The log object |
| 165 | + """ |
| 166 | + path = f"/logs/{log_id}" |
| 167 | + resp = await AsyncRequest[Logs.GetResponse]( |
| 168 | + path=path, params={}, verb="get" |
| 169 | + ).perform_with_content() |
| 170 | + return resp |
| 171 | + |
| 172 | + @classmethod |
| 173 | + async def list_async(cls, params: Optional[ListParams] = None) -> ListResponse: |
| 174 | + """ |
| 175 | + Retrieve a list of logs (async). |
| 176 | + see more: https://resend.com/docs/api-reference/logs/list-logs |
| 177 | +
|
| 178 | + Args: |
| 179 | + params (Optional[ListParams]): Optional pagination parameters |
| 180 | + - limit: Number of logs to retrieve (max 100, min 1) |
| 181 | + - after: ID after which to retrieve more logs |
| 182 | + - before: ID before which to retrieve more logs |
| 183 | +
|
| 184 | + Returns: |
| 185 | + ListResponse: A list of log objects |
| 186 | + """ |
| 187 | + base_path = "/logs" |
| 188 | + query_params = cast(Dict[Any, Any], params) if params else None |
| 189 | + path = PaginationHelper.build_paginated_path(base_path, query_params) |
| 190 | + resp = await AsyncRequest[Logs.ListResponse]( |
| 191 | + path=path, params={}, verb="get" |
| 192 | + ).perform_with_content() |
| 193 | + return resp |
0 commit comments