agentmail-clone-v1 0.1.0

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

@@ -0,0 +1,336 @@
+# emailagent_sdk_generated.DomainsApi
+
+All URIs are relative to *http://127.0.0.1:3000*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_domain**](DomainsApi.md#create_domain) | **POST** /api/v1/domains | Create custom domain
+[**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /api/v1/domains/{id} | Delete custom domain
+[**list_domains**](DomainsApi.md#list_domains) | **GET** /api/v1/domains | List custom domains
+[**verify_domain**](DomainsApi.md#verify_domain) | **POST** /api/v1/domains/{id}/verify | Refresh DNS verification status for a domain
+
+
+# **create_domain**
+> DomainResponse create_domain(create_domain_request, idempotency_key=idempotency_key)
+
+Create custom domain
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.create_domain_request import CreateDomainRequest
+from emailagent_sdk_generated.models.domain_response import DomainResponse
+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.DomainsApi(api_client)
+    create_domain_request = emailagent_sdk_generated.CreateDomainRequest() # CreateDomainRequest | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Create custom domain
+        api_response = api_instance.create_domain(create_domain_request, idempotency_key=idempotency_key)
+        print("The response of DomainsApi->create_domain:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DomainsApi->create_domain: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_domain_request** | [**CreateDomainRequest**](CreateDomainRequest.md)|  | 
+ **idempotency_key** | **str**| Optional key for safe retries of mutating operations. | [optional] 
+
+### Return type
+
+[**DomainResponse**](DomainResponse.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** | Domain created |  -  |
+**400** | Validation error |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**409** | Domain already exists or idempotency conflict |  -  |
+**422** | Plan does not allow custom domains or 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)
+
+# **delete_domain**
+> OkResponse delete_domain(id, idempotency_key=idempotency_key)
+
+Delete custom domain
+
+### 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.DomainsApi(api_client)
+    id = 'id_example' # str | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Delete custom domain
+        api_response = api_instance.delete_domain(id, idempotency_key=idempotency_key)
+        print("The response of DomainsApi->delete_domain:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DomainsApi->delete_domain: %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** | Domain deleted |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**404** | Domain 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_domains**
+> DomainListResponse list_domains()
+
+List custom domains
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.domain_list_response import DomainListResponse
+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.DomainsApi(api_client)
+
+    try:
+        # List custom domains
+        api_response = api_instance.list_domains()
+        print("The response of DomainsApi->list_domains:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DomainsApi->list_domains: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DomainListResponse**](DomainListResponse.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** | Domains for the authenticated organization |  -  |
+**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)
+
+# **verify_domain**
+> DomainResponse verify_domain(id, idempotency_key=idempotency_key)
+
+Refresh DNS verification status for a domain
+
+### Example
+
+* Bearer (APIKey) Authentication (bearerAuth):
+
+```python
+import emailagent_sdk_generated
+from emailagent_sdk_generated.models.domain_response import DomainResponse
+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.DomainsApi(api_client)
+    id = 'id_example' # str | 
+    idempotency_key = 'idempotency_key_example' # str | Optional key for safe retries of mutating operations. (optional)
+
+    try:
+        # Refresh DNS verification status for a domain
+        api_response = api_instance.verify_domain(id, idempotency_key=idempotency_key)
+        print("The response of DomainsApi->verify_domain:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DomainsApi->verify_domain: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+ **idempotency_key** | **str**| Optional key for safe retries of mutating operations. | [optional] 
+
+### Return type
+
+[**DomainResponse**](DomainResponse.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** | Domain verification refreshed |  -  |
+**401** | Missing or invalid bearer token |  -  |
+**403** | API key lacks required scope |  -  |
+**404** | Domain not found |  -  |
+**409** | Idempotency conflict or request in progress |  -  |
+**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)
+

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

@@ -0,0 +1,43 @@
+# Email
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**org_id** | **str** |  | 
+**inbox_id** | **str** |  | [optional] 
+**direction** | **str** |  | 
+**delivery_status** | **str** |  | 
+**message_id** | **str** |  | [optional] 
+**subject** | **str** |  | 
+**from_address** | **str** |  | 
+**to_addresses** | **List[str]** |  | 
+**text_body** | **str** |  | [optional] 
+**html_body** | **str** |  | [optional] 
+**is_read** | **bool** |  | 
+**status** | **str** |  | 
+**provider_payload** | **Dict[str, object]** |  | [optional] 
+**created_at** | **datetime** |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.email import Email
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Email from a JSON string
+email_instance = Email.from_json(json)
+# print the JSON string representation of the object
+print(Email.to_json())
+
+# convert the object into a dict
+email_dict = email_instance.to_dict()
+# create an instance of Email from a dict
+email_from_dict = Email.from_dict(email_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/EmailListResponse.md

@@ -0,0 +1,29 @@
+# EmailListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**List[Email]**](Email.md) |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.email_list_response import EmailListResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailListResponse from a JSON string
+email_list_response_instance = EmailListResponse.from_json(json)
+# print the JSON string representation of the object
+print(EmailListResponse.to_json())
+
+# convert the object into a dict
+email_list_response_dict = email_list_response_instance.to_dict()
+# create an instance of EmailListResponse from a dict
+email_list_response_from_dict = EmailListResponse.from_dict(email_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/EmailResponse.md

@@ -0,0 +1,29 @@
+# EmailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Email**](Email.md) |  | 
+
+## Example
+
+```python
+from emailagent_sdk_generated.models.email_response import EmailResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailResponse from a JSON string
+email_response_instance = EmailResponse.from_json(json)
+# print the JSON string representation of the object
+print(EmailResponse.to_json())
+
+# convert the object into a dict
+email_response_dict = email_response_instance.to_dict()
+# create an instance of EmailResponse from a dict
+email_response_from_dict = EmailResponse.from_dict(email_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)
+
+