agentmail-clone-v1 0.1.0

package/sdks/python/generated/emailagent_sdk_generated/docs/EmailsApi.md

@@ -0,0 +1,353 @@
+# emailagent_sdk_generated.EmailsApi
+
+All URIs are relative to *http://127.0.0.1:3000*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_email**](EmailsApi.md#delete_email) | **DELETE** /api/v1/emails/{id} | Delete email
+[**list_emails**](EmailsApi.md#list_emails) | **GET** /api/v1/emails | List emails
+[**send_email**](EmailsApi.md#send_email) | **POST** /api/v1/emails/send | Send outbound email from an inbox
+[**update_email_read**](EmailsApi.md#update_email_read) | **PATCH** /api/v1/emails/{id}/read | Update email read state
+
+
+# **delete_email**
+> OkResponse delete_email(id, idempotency_key=idempotency_key)
+
+Delete email
+
+Soft-deletes an email record. Requires `emails:write` scope.
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.ok_response import OkResponse
+from emailagent_sdk_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://127.0.0.1:3000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = emailagent_sdk_generated.Configuration(
+    host = "http://127.0.0.1:3000"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (APIKey): bearerAuth
+configuration = emailagent_sdk_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with emailagent_sdk_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = emailagent_sdk_generated.EmailsApi(api_client)
+    id = 'id_example' # str | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Delete email
+        api_response = api_instance.delete_email(id, idempotency_key=idempotency_key)
+        print("The response of EmailsApi->delete_email:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailsApi->delete_email: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+ **idempotency_key** | **str**| Optional key for safe retries of mutating operations. | [optional] 
+
+### Return type
+
+[**OkResponse**](OkResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Email deleted |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**404** | Email not found |  -  |
+**409** | Idempotency conflict or request in progress |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **list_emails**
+> EmailListResponse list_emails(inbox_id=inbox_id)
+
+List emails
+
+Returns inbound and outbound email records. Requires `emails:read` scope.
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.email_list_response import EmailListResponse
+from emailagent_sdk_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://127.0.0.1:3000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = emailagent_sdk_generated.Configuration(
+    host = "http://127.0.0.1:3000"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (APIKey): bearerAuth
+configuration = emailagent_sdk_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with emailagent_sdk_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = emailagent_sdk_generated.EmailsApi(api_client)
+    inbox_id = 'inbox_id_example' # str | Optional inbox filter. (optional)
+
+    try:
+        # List emails
+        api_response = api_instance.list_emails(inbox_id=inbox_id)
+        print("The response of EmailsApi->list_emails:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailsApi->list_emails: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbox_id** | **str**| Optional inbox filter. | [optional] 
+
+### Return type
+
+[**EmailListResponse**](EmailListResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Email records for the authenticated organization |  -  |
+**400** | Validation error |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **send_email**
+> EmailResponse send_email(send_email_request, idempotency_key=idempotency_key)
+
+Send outbound email from an inbox
+
+Requires `emails:send` scope.
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.email_response import EmailResponse
+from emailagent_sdk_generated.models.send_email_request import SendEmailRequest
+from emailagent_sdk_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://127.0.0.1:3000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = emailagent_sdk_generated.Configuration(
+    host = "http://127.0.0.1:3000"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (APIKey): bearerAuth
+configuration = emailagent_sdk_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with emailagent_sdk_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = emailagent_sdk_generated.EmailsApi(api_client)
+    send_email_request = emailagent_sdk_generated.SendEmailRequest() # SendEmailRequest | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Send outbound email from an inbox
+        api_response = api_instance.send_email(send_email_request, idempotency_key=idempotency_key)
+        print("The response of EmailsApi->send_email:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailsApi->send_email: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_email_request** | [**SendEmailRequest**](SendEmailRequest.md)|  | 
+ **idempotency_key** | **str**| Optional key for safe retries of mutating operations. | [optional] 
+
+### Return type
+
+[**EmailResponse**](EmailResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Email send accepted |  -  |
+**400** | Validation error |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**409** | Idempotency conflict or request in progress |  -  |
+**422** | Plan limit exceeded |  -  |
+**429** | Rate limit exceeded |  -  |
+**500** | Provider or internal error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **update_email_read**
+> EmailResponse update_email_read(id, update_email_read_request, idempotency_key=idempotency_key)
+
+Update email read state
+
+Marks an email as read/unread. Requires `emails:write` scope.
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.email_response import EmailResponse
+from emailagent_sdk_generated.models.update_email_read_request import UpdateEmailReadRequest
+from emailagent_sdk_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://127.0.0.1:3000
+# See configuration.py for a list of all supported configuration parameters.
+configuration = emailagent_sdk_generated.Configuration(
+    host = "http://127.0.0.1:3000"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (APIKey): bearerAuth
+configuration = emailagent_sdk_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with emailagent_sdk_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = emailagent_sdk_generated.EmailsApi(api_client)
+    id = 'id_example' # str | 
+    update_email_read_request = emailagent_sdk_generated.UpdateEmailReadRequest() # UpdateEmailReadRequest | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Update email read state
+        api_response = api_instance.update_email_read(id, update_email_read_request, idempotency_key=idempotency_key)
+        print("The response of EmailsApi->update_email_read:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailsApi->update_email_read: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+ **update_email_read_request** | [**UpdateEmailReadRequest**](UpdateEmailReadRequest.md)|  | 
+ **idempotency_key** | **str**| Optional key for safe retries of mutating operations. | [optional] 
+
+### Return type
+
+[**EmailResponse**](EmailResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Email updated |  -  |
+**400** | Validation error |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**404** | Email not found |  -  |
+**409** | Idempotency conflict or request in progress |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/sdks/python/generated/emailagent_sdk_generated/docs/ErrorResponse.md

@@ -0,0 +1,29 @@
+# ErrorResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **str** |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.error_response import ErrorResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ErrorResponse from a JSON string
+error_response_instance = ErrorResponse.from_json(json)
+# print the JSON string representation of the object
+print(ErrorResponse.to_json())
+
+# convert the object into a dict
+error_response_dict = error_response_instance.to_dict()
+# create an instance of ErrorResponse from a dict
+error_response_from_dict = ErrorResponse.from_dict(error_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

package/sdks/python/generated/emailagent_sdk_generated/docs/Inbox.md

@@ -0,0 +1,38 @@
+# Inbox
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**org_id** | **str** |  | 
+**local_part** | **str** |  | 
+**domain_name** | **str** |  | 
+**email_address** | **str** |  | 
+**display_name** | **str** |  | [optional] 
+**status** | **str** |  | 
+**created_at** | **datetime** |  | 
+**updated_at** | **datetime** |  | 
+**deleted_at** | **datetime** |  | [optional] 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.inbox import Inbox
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Inbox from a JSON string
+inbox_instance = Inbox.from_json(json)
+# print the JSON string representation of the object
+print(Inbox.to_json())
+
+# convert the object into a dict
+inbox_dict = inbox_instance.to_dict()
+# create an instance of Inbox from a dict
+inbox_from_dict = Inbox.from_dict(inbox_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

package/sdks/python/generated/emailagent_sdk_generated/docs/InboxListResponse.md

@@ -0,0 +1,29 @@
+# InboxListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**List[Inbox]**](Inbox.md) |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.inbox_list_response import InboxListResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of InboxListResponse from a JSON string
+inbox_list_response_instance = InboxListResponse.from_json(json)
+# print the JSON string representation of the object
+print(InboxListResponse.to_json())
+
+# convert the object into a dict
+inbox_list_response_dict = inbox_list_response_instance.to_dict()
+# create an instance of InboxListResponse from a dict
+inbox_list_response_from_dict = InboxListResponse.from_dict(inbox_list_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

package/sdks/python/generated/emailagent_sdk_generated/docs/InboxResponse.md

@@ -0,0 +1,29 @@
+# InboxResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Inbox**](Inbox.md) |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.inbox_response import InboxResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of InboxResponse from a JSON string
+inbox_response_instance = InboxResponse.from_json(json)
+# print the JSON string representation of the object
+print(InboxResponse.to_json())
+
+# convert the object into a dict
+inbox_response_dict = inbox_response_instance.to_dict()
+# create an instance of InboxResponse from a dict
+inbox_response_from_dict = InboxResponse.from_dict(inbox_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+