arthur-client 1.4.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur_client/api_bindings/docs/AlertRule.md

@@ -0,0 +1,40 @@
+# AlertRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | The id of the alert rule. | 
+**model_id** | **str** | The model id of the alert rule. | 
+**name** | **str** | The name of the alert rule. | 
+**description** | **str** |  | [optional] 
+**threshold** | **float** | The threshold that will trigger the alert rule. | 
+**bound** | [**AlertBound**](AlertBound.md) | The bound of the alert rule. | 
+**query** | **str** | The query of the alert rule. | 
+**metric_name** | **str** | The name of the metric returned by the alert rule query. | 
+**last_updated_by_user** | [**User**](User.md) |  | [optional] 
+**notification_webhooks** | [**List[AlertRuleNotificationWebhook]**](AlertRuleNotificationWebhook.md) | Notification webhooks configured for the alert rule. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.alert_rule import AlertRule
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AlertRule from a JSON string
+alert_rule_instance = AlertRule.from_json(json)
+# print the JSON string representation of the object
+print(AlertRule.to_json())
+
+# convert the object into a dict
+alert_rule_dict = alert_rule_instance.to_dict()
+# create an instance of AlertRule from a dict
+alert_rule_from_dict = AlertRule.from_dict(alert_rule_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)
+
+

arthur_client/api_bindings/docs/AlertRuleNotificationWebhook.md

@@ -0,0 +1,30 @@
+# AlertRuleNotificationWebhook
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Webhook ID. | 
+**name** | **str** | Webhook name. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.alert_rule_notification_webhook import AlertRuleNotificationWebhook
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AlertRuleNotificationWebhook from a JSON string
+alert_rule_notification_webhook_instance = AlertRuleNotificationWebhook.from_json(json)
+# print the JSON string representation of the object
+print(AlertRuleNotificationWebhook.to_json())
+
+# convert the object into a dict
+alert_rule_notification_webhook_dict = alert_rule_notification_webhook_instance.to_dict()
+# create an instance of AlertRuleNotificationWebhook from a dict
+alert_rule_notification_webhook_from_dict = AlertRuleNotificationWebhook.from_dict(alert_rule_notification_webhook_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)
+
+

arthur_client/api_bindings/docs/AlertRuleSort.md

@@ -0,0 +1,12 @@
+# AlertRuleSort
+
+
+## Enum
+
+* `CREATED_AT` (value: `'created_at'`)
+
+* `NAME` (value: `'name'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AlertRulesV1Api.md

@@ -0,0 +1,431 @@
+# arthur_client.api_bindings.AlertRulesV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_alert_rule**](AlertRulesV1Api.md#delete_alert_rule) | **DELETE** /api/v1/alert_rules/{alert_rule_id} | Delete Alert Rule By Id
+[**get_alert_rule**](AlertRulesV1Api.md#get_alert_rule) | **GET** /api/v1/alert_rules/{alert_rule_id} | Get Alert Rule By Id
+[**get_model_alert_rules**](AlertRulesV1Api.md#get_model_alert_rules) | **GET** /api/v1/models/{model_id}/alert_rules | Get Model Alert Rules
+[**patch_alert_rule**](AlertRulesV1Api.md#patch_alert_rule) | **PATCH** /api/v1/alert_rules/{alert_rule_id} | Update Model Alert Rule
+[**post_model_alert_rule**](AlertRulesV1Api.md#post_model_alert_rule) | **POST** /api/v1/models/{model_id}/alert_rules | Create Model Alert Rule
+
+
+# **delete_alert_rule**
+> delete_alert_rule(alert_rule_id)
+
+Delete Alert Rule By Id
+
+Deletes a single alert rule by ID. Requires alert_rule_delete permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.AlertRulesV1Api(api_client)
+    alert_rule_id = 'alert_rule_id_example' # str | 
+
+    try:
+        # Delete Alert Rule By Id
+        api_instance.delete_alert_rule(alert_rule_id)
+    except Exception as e:
+        print("Exception when calling AlertRulesV1Api->delete_alert_rule: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alert_rule_id** | **str**|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation 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)
+
+# **get_alert_rule**
+> AlertRule get_alert_rule(alert_rule_id)
+
+Get Alert Rule By Id
+
+Returns a single alert rule by ID. Requires alert_rule_read permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.alert_rule import AlertRule
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.AlertRulesV1Api(api_client)
+    alert_rule_id = 'alert_rule_id_example' # str | 
+
+    try:
+        # Get Alert Rule By Id
+        api_response = api_instance.get_alert_rule(alert_rule_id)
+        print("The response of AlertRulesV1Api->get_alert_rule:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AlertRulesV1Api->get_alert_rule: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alert_rule_id** | **str**|  | 
+
+### Return type
+
+[**AlertRule**](AlertRule.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation 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)
+
+# **get_model_alert_rules**
+> ResourceListAlertRule get_model_alert_rules(model_id, sort=sort, order=order, name=name, bound=bound, query=query, threshold_less_than=threshold_less_than, threshold_greater_than=threshold_greater_than, metric_name=metric_name, page=page, page_size=page_size)
+
+Get Model Alert Rules
+
+Returns a list of alert rules associated with a model. Requires model_list_alert_rules permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.alert_bound import AlertBound
+from arthur_client.api_bindings.models.alert_rule_sort import AlertRuleSort
+from arthur_client.api_bindings.models.resource_list_alert_rule import ResourceListAlertRule
+from arthur_client.api_bindings.models.sort_order import SortOrder
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.AlertRulesV1Api(api_client)
+    model_id = 'model_id_example' # str | 
+    sort = arthur_client.api_bindings.AlertRuleSort() # AlertRuleSort | The field to sort by. (optional)
+    order = arthur_client.api_bindings.SortOrder() # SortOrder | The order to sort by. (optional)
+    name = 'name_example' # str | The name of the alert rule to search by. (optional)
+    bound = arthur_client.api_bindings.AlertBound() # AlertBound | The bound to filter by. (optional)
+    query = 'query_example' # str | The query to filter by. (optional)
+    threshold_less_than = 3.4 # float | The threshold to filter by, less than. (optional)
+    threshold_greater_than = 3.4 # float | The threshold to filter by, greater than. (optional)
+    metric_name = 'metric_name_example' # str | The name of the alert rule query metric to search by. (optional)
+    page = 1 # int | The page to return starting from 1 up to total_pages. (optional) (default to 1)
+    page_size = 20 # int | The number of records per page. The max is 1000. (optional) (default to 20)
+
+    try:
+        # Get Model Alert Rules
+        api_response = api_instance.get_model_alert_rules(model_id, sort=sort, order=order, name=name, bound=bound, query=query, threshold_less_than=threshold_less_than, threshold_greater_than=threshold_greater_than, metric_name=metric_name, page=page, page_size=page_size)
+        print("The response of AlertRulesV1Api->get_model_alert_rules:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AlertRulesV1Api->get_model_alert_rules: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model_id** | **str**|  | 
+ **sort** | [**AlertRuleSort**](.md)| The field to sort by. | [optional] 
+ **order** | [**SortOrder**](.md)| The order to sort by. | [optional] 
+ **name** | **str**| The name of the alert rule to search by. | [optional] 
+ **bound** | [**AlertBound**](.md)| The bound to filter by. | [optional] 
+ **query** | **str**| The query to filter by. | [optional] 
+ **threshold_less_than** | **float**| The threshold to filter by, less than. | [optional] 
+ **threshold_greater_than** | **float**| The threshold to filter by, greater than. | [optional] 
+ **metric_name** | **str**| The name of the alert rule query metric to search by. | [optional] 
+ **page** | **int**| The page to return starting from 1 up to total_pages. | [optional] [default to 1]
+ **page_size** | **int**| The number of records per page. The max is 1000. | [optional] [default to 20]
+
+### Return type
+
+[**ResourceListAlertRule**](ResourceListAlertRule.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation 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)
+
+# **patch_alert_rule**
+> AlertRule patch_alert_rule(alert_rule_id, patch_alert_rule)
+
+Update Model Alert Rule
+
+Updates an alert rule. Requires alert_rule_update permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.alert_rule import AlertRule
+from arthur_client.api_bindings.models.patch_alert_rule import PatchAlertRule
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.AlertRulesV1Api(api_client)
+    alert_rule_id = 'alert_rule_id_example' # str | 
+    patch_alert_rule = arthur_client.api_bindings.PatchAlertRule() # PatchAlertRule | 
+
+    try:
+        # Update Model Alert Rule
+        api_response = api_instance.patch_alert_rule(alert_rule_id, patch_alert_rule)
+        print("The response of AlertRulesV1Api->patch_alert_rule:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AlertRulesV1Api->patch_alert_rule: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **alert_rule_id** | **str**|  | 
+ **patch_alert_rule** | [**PatchAlertRule**](PatchAlertRule.md)|  | 
+
+### Return type
+
+[**AlertRule**](AlertRule.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**400** | Bad Request |  -  |
+**422** | Validation 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)
+
+# **post_model_alert_rule**
+> AlertRule post_model_alert_rule(model_id, post_alert_rule)
+
+Create Model Alert Rule
+
+Creates an alert rule. Requires model_create_alert_rule permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.alert_rule import AlertRule
+from arthur_client.api_bindings.models.post_alert_rule import PostAlertRule
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# 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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.AlertRulesV1Api(api_client)
+    model_id = 'model_id_example' # str | 
+    post_alert_rule = arthur_client.api_bindings.PostAlertRule() # PostAlertRule | 
+
+    try:
+        # Create Model Alert Rule
+        api_response = api_instance.post_model_alert_rule(model_id, post_alert_rule)
+        print("The response of AlertRulesV1Api->post_model_alert_rule:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AlertRulesV1Api->post_model_alert_rule: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model_id** | **str**|  | 
+ **post_alert_rule** | [**PostAlertRule**](PostAlertRule.md)|  | 
+
+### Return type
+
+[**AlertRule**](AlertRule.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**400** | Bad Request |  -  |
+**422** | Validation 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)
+

arthur_client/api_bindings/docs/AlertSort.md

@@ -0,0 +1,12 @@
+# AlertSort
+
+
+## Enum
+
+* `CREATED_AT` (value: `'created_at'`)
+
+* `TIMESTAMP` (value: `'timestamp'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/AlertWebhookCalled.md

@@ -0,0 +1,31 @@
+# AlertWebhookCalled
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook_id** | **str** | The id of the webhook that was triggered by the alert. | 
+**webhook_name** | **str** | The name of the webhook. | 
+**webhook_result** | [**WebhookResult**](WebhookResult.md) | The result of the webhook call. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.alert_webhook_called import AlertWebhookCalled
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AlertWebhookCalled from a JSON string
+alert_webhook_called_instance = AlertWebhookCalled.from_json(json)
+# print the JSON string representation of the object
+print(AlertWebhookCalled.to_json())
+
+# convert the object into a dict
+alert_webhook_called_dict = alert_webhook_called_instance.to_dict()
+# create an instance of AlertWebhookCalled from a dict
+alert_webhook_called_from_dict = AlertWebhookCalled.from_dict(alert_webhook_called_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)
+
+