spatialflow 0.1.0__py3-none-any.whl

spatialflow/_generated/docs/EmailApi.md

@@ -0,0 +1,541 @@
+# spatialflow_generated.EmailApi
+
+All URIs are relative to *https://api.spatialflow.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**apps_email_api_get_email_history**](EmailApi.md#apps_email_api_get_email_history) | **GET** /api/v1/email/history | Get Email History
+[**apps_email_api_get_email_status**](EmailApi.md#apps_email_api_get_email_status) | **GET** /api/v1/email/status/{email_id} | Get Email Status
+[**apps_email_api_get_queue_stats**](EmailApi.md#apps_email_api_get_queue_stats) | **GET** /api/v1/email/queue-stats | Get Queue Stats
+[**apps_email_api_health_check**](EmailApi.md#apps_email_api_health_check) | **GET** /api/v1/email/health | Health Check
+[**apps_email_api_preview_email_template**](EmailApi.md#apps_email_api_preview_email_template) | **GET** /api/v1/email/preview/{template_name} | Preview Email Template
+[**apps_email_api_send_email**](EmailApi.md#apps_email_api_send_email) | **POST** /api/v1/email/send | Send Email
+[**apps_email_api_send_test_email**](EmailApi.md#apps_email_api_send_test_email) | **POST** /api/v1/email/test | Send Test Email
+
+
+# **apps_email_api_get_email_history**
+> apps_email_api_get_email_history(limit=limit, offset=offset)
+
+Get Email History
+
+Get email history for the current user
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+    limit = 50 # int |  (optional) (default to 50)
+    offset = 0 # int |  (optional) (default to 0)
+
+    try:
+        # Get Email History
+        await api_instance.apps_email_api_get_email_history(limit=limit, offset=offset)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_get_email_history: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **int**|  | [optional] [default to 50]
+ **offset** | **int**|  | [optional] [default to 0]
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **apps_email_api_get_email_status**
+> EmailStatusResponse apps_email_api_get_email_status(email_id)
+
+Get Email Status
+
+Check email delivery status
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.models.email_status_response import EmailStatusResponse
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+    email_id = 'email_id_example' # str | 
+
+    try:
+        # Get Email Status
+        api_response = await api_instance.apps_email_api_get_email_status(email_id)
+        print("The response of EmailApi->apps_email_api_get_email_status:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_get_email_status: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **str**|  | 
+
+### Return type
+
+[**EmailStatusResponse**](EmailStatusResponse.md)
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**403** | Forbidden |  -  |
+
+[[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)
+
+# **apps_email_api_get_queue_stats**
+> EmailQueueStats apps_email_api_get_queue_stats()
+
+Get Queue Stats
+
+Get email queue statistics (admin only)
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.models.email_queue_stats import EmailQueueStats
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+
+    try:
+        # Get Queue Stats
+        api_response = await api_instance.apps_email_api_get_queue_stats()
+        print("The response of EmailApi->apps_email_api_get_queue_stats:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_get_queue_stats: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**EmailQueueStats**](EmailQueueStats.md)
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **apps_email_api_health_check**
+> EmailHealthResponse apps_email_api_health_check()
+
+Health Check
+
+Email service health check
+
+### Example
+
+
+```python
+import spatialflow_generated
+from spatialflow_generated.models.email_health_response import EmailHealthResponse
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+
+    try:
+        # Health Check
+        api_response = await api_instance.apps_email_api_health_check()
+        print("The response of EmailApi->apps_email_api_health_check:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_health_check: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**EmailHealthResponse**](EmailHealthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **apps_email_api_preview_email_template**
+> apps_email_api_preview_email_template(template_name, format=format)
+
+Preview Email Template
+
+Preview an email template with sample data (admin only)  Args:     template_name: Name of the template to preview     format: Output format - 'html' or 'txt' (default: 'html')
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+    template_name = 'template_name_example' # str | 
+    format = 'html' # str |  (optional) (default to 'html')
+
+    try:
+        # Preview Email Template
+        await api_instance.apps_email_api_preview_email_template(template_name, format=format)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_preview_email_template: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_name** | **str**|  | 
+ **format** | **str**|  | [optional] [default to 'html']
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**404** | Not Found |  -  |
+**500** | Internal Server 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)
+
+# **apps_email_api_send_email**
+> Dict[str, object] apps_email_api_send_email(send_email_request)
+
+Send Email
+
+Queue email for delivery (admin only)
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.models.send_email_request import SendEmailRequest
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+    send_email_request = spatialflow_generated.SendEmailRequest() # SendEmailRequest | 
+
+    try:
+        # Send Email
+        api_response = await api_instance.apps_email_api_send_email(send_email_request)
+        print("The response of EmailApi->apps_email_api_send_email:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_send_email: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_email_request** | [**SendEmailRequest**](SendEmailRequest.md)|  | 
+
+### Return type
+
+**Dict[str, object]**
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[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)
+
+# **apps_email_api_send_test_email**
+> Dict[str, object] apps_email_api_send_test_email()
+
+Send Test Email
+
+Send a test email to verify email configuration (admin only)
+
+### Example
+
+* Bearer Authentication (JWTBearer):
+
+```python
+import spatialflow_generated
+from spatialflow_generated.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.spatialflow.io
+# See configuration.py for a list of all supported configuration parameters.
+configuration = spatialflow_generated.Configuration(
+    host = "https://api.spatialflow.io"
+)
+
+# 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: JWTBearer
+configuration = spatialflow_generated.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with spatialflow_generated.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = spatialflow_generated.EmailApi(api_client)
+
+    try:
+        # Send Test Email
+        api_response = await api_instance.apps_email_api_send_test_email()
+        print("The response of EmailApi->apps_email_api_send_test_email:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling EmailApi->apps_email_api_send_test_email: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Dict[str, object]**
+
+### Authorization
+
+[JWTBearer](../README.md#JWTBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**500** | Internal Server 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)
+

spatialflow/_generated/docs/EmailHealthResponse.md

@@ -0,0 +1,31 @@
+# EmailHealthResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **str** |  | 
+**checks** | **Dict[str, object]** |  | 
+**timestamp** | **datetime** |  | 
+
+## Example
+
+```python
+from spatialflow_generated.models.email_health_response import EmailHealthResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailHealthResponse from a JSON string
+email_health_response_instance = EmailHealthResponse.from_json(json)
+# print the JSON string representation of the object
+print(EmailHealthResponse.to_json())
+
+# convert the object into a dict
+email_health_response_dict = email_health_response_instance.to_dict()
+# create an instance of EmailHealthResponse from a dict
+email_health_response_from_dict = EmailHealthResponse.from_dict(email_health_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)
+
+

spatialflow/_generated/docs/EmailQueueStats.md

@@ -0,0 +1,34 @@
+# EmailQueueStats
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pending** | **int** |  | 
+**queued** | **int** |  | 
+**delivered** | **int** |  | 
+**failed** | **int** |  | 
+**total_today** | **int** |  | 
+**total_this_hour** | **int** |  | 
+
+## Example
+
+```python
+from spatialflow_generated.models.email_queue_stats import EmailQueueStats
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailQueueStats from a JSON string
+email_queue_stats_instance = EmailQueueStats.from_json(json)
+# print the JSON string representation of the object
+print(EmailQueueStats.to_json())
+
+# convert the object into a dict
+email_queue_stats_dict = email_queue_stats_instance.to_dict()
+# create an instance of EmailQueueStats from a dict
+email_queue_stats_from_dict = EmailQueueStats.from_dict(email_queue_stats_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)
+
+

spatialflow/_generated/docs/EmailStats.md

@@ -0,0 +1,31 @@
+# EmailStats
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_emails** | **int** |  | 
+**delivered** | **int** |  | 
+**failed** | **int** |  | 
+
+## Example
+
+```python
+from spatialflow_generated.models.email_stats import EmailStats
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailStats from a JSON string
+email_stats_instance = EmailStats.from_json(json)
+# print the JSON string representation of the object
+print(EmailStats.to_json())
+
+# convert the object into a dict
+email_stats_dict = email_stats_instance.to_dict()
+# create an instance of EmailStats from a dict
+email_stats_from_dict = EmailStats.from_dict(email_stats_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)
+
+

spatialflow/_generated/docs/EmailStatusResponse.md

@@ -0,0 +1,36 @@
+# EmailStatusResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** |  | 
+**to_email** | **str** |  | 
+**subject** | **str** |  | 
+**status** | **str** |  | 
+**created_at** | **datetime** |  | 
+**delivered_at** | **datetime** |  | 
+**retry_count** | **int** |  | 
+**error_message** | **str** |  | 
+
+## Example
+
+```python
+from spatialflow_generated.models.email_status_response import EmailStatusResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of EmailStatusResponse from a JSON string
+email_status_response_instance = EmailStatusResponse.from_json(json)
+# print the JSON string representation of the object
+print(EmailStatusResponse.to_json())
+
+# convert the object into a dict
+email_status_response_dict = email_status_response_instance.to_dict()
+# create an instance of EmailStatusResponse from a dict
+email_status_response_from_dict = EmailStatusResponse.from_dict(email_status_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)
+
+

spatialflow/_generated/docs/ErrorResponse.md

@@ -0,0 +1,32 @@
+# ErrorResponse
+
+Standard error response schema for all API endpoints.  Follows Django Ninja standard format and aligns with validation errors. Compatible with frontend apiClient.ts error handling.  Attributes:     detail: Human-readable error message or machine-readable error code     error_code: Optional machine-readable error identifier     details: Optional additional context (field errors, validation details, etc.)  Examples:     Simple error:         {\"detail\": \"Resource not found\"}      Error with code:         {\"detail\": \"FORBIDDEN\", \"error_code\": \"INSUFFICIENT_PERMISSIONS\"}      Validation error:         {             \"detail\": \"Validation failed\",             \"details\": {                 \"name\": [\"This field is required\"],                 \"email\": [\"Invalid email format\"]             }         }
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | 
+**error_code** | **str** |  | [optional] 
+**details** | **Dict[str, object]** |  | [optional] 
+
+## Example
+
+```python
+from spatialflow_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)
+
+