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

arthur_client/api_bindings/docs/DefaultApi.md

@@ -0,0 +1,74 @@
+# arthur_client.api_bindings.DefaultApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**health_check_api_health_get**](DefaultApi.md#health_check_api_health_get) | **GET** /api/health | Health Check
+
+
+# **health_check_api_health_get**
+> HealthStatus health_check_api_health_get()
+
+Health Check
+
+Confirms the API is healthy and responsive.
+
+### Example
+
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.health_status import HealthStatus
+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"
+)
+
+
+# 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.DefaultApi(api_client)
+
+    try:
+        # Health Check
+        api_response = api_instance.health_check_api_health_get()
+        print("The response of DefaultApi->health_check_api_health_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DefaultApi->health_check_api_health_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthStatus**](HealthStatus.md)
+
+### Authorization
+
+No authorization required
+
+### 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 |  -  |
+
+[[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/Definition.md

@@ -0,0 +1,34 @@
+# Definition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) |  | [optional] [default to []]
+**nullable** | **bool** |  | [optional] 
+**id** | **str** | Unique ID of the schema node. | [optional] 
+**dtype** | [**DType**](DType.md) |  | 
+**object** | [**Dict[str, ObjectValue]**](ObjectValue.md) |  | 
+**items** | [**Items**](Items.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.definition import Definition
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Definition from a JSON string
+definition_instance = Definition.from_json(json)
+# print the JSON string representation of the object
+print(Definition.to_json())
+
+# convert the object into a dict
+definition_dict = definition_instance.to_dict()
+# create an instance of Definition from a dict
+definition_from_dict = Definition.from_dict(definition_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/DeleteGroupMembership.md

@@ -0,0 +1,29 @@
+# DeleteGroupMembership
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_ids** | **List[str]** | The ID of the user to remove from the group. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.delete_group_membership import DeleteGroupMembership
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DeleteGroupMembership from a JSON string
+delete_group_membership_instance = DeleteGroupMembership.from_json(json)
+# print the JSON string representation of the object
+print(DeleteGroupMembership.to_json())
+
+# convert the object into a dict
+delete_group_membership_dict = delete_group_membership_instance.to_dict()
+# create an instance of DeleteGroupMembership from a dict
+delete_group_membership_from_dict = DeleteGroupMembership.from_dict(delete_group_membership_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/DeleteModelTaskJobSpec.md

@@ -0,0 +1,30 @@
+# DeleteModelTaskJobSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_type** | **str** |  | [optional] [default to 'delete_model_task']
+**scope_model_id** | **str** | The id of the model to delete. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.delete_model_task_job_spec import DeleteModelTaskJobSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DeleteModelTaskJobSpec from a JSON string
+delete_model_task_job_spec_instance = DeleteModelTaskJobSpec.from_json(json)
+# print the JSON string representation of the object
+print(DeleteModelTaskJobSpec.to_json())
+
+# convert the object into a dict
+delete_model_task_job_spec_dict = delete_model_task_job_spec_instance.to_dict()
+# create an instance of DeleteModelTaskJobSpec from a dict
+delete_model_task_job_spec_from_dict = DeleteModelTaskJobSpec.from_dict(delete_model_task_job_spec_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/Dimension.md

@@ -0,0 +1,30 @@
+# Dimension
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the dimension. | 
+**value** | **str** | Value of the dimension. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.dimension import Dimension
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Dimension from a JSON string
+dimension_instance = Dimension.from_json(json)
+# print the JSON string representation of the object
+print(Dimension.to_json())
+
+# convert the object into a dict
+dimension_dict = dimension_instance.to_dict()
+# create an instance of Dimension from a dict
+dimension_from_dict = Dimension.from_dict(dimension_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/ExampleConfig.md

@@ -0,0 +1,30 @@
+# ExampleConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**example** | **str** | Custom example for the sensitive data | 
+**result** | **bool** | Boolean value representing if the example passes or fails the the sensitive data rule  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.example_config import ExampleConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExampleConfig from a JSON string
+example_config_instance = ExampleConfig.from_json(json)
+# print the JSON string representation of the object
+print(ExampleConfig.to_json())
+
+# convert the object into a dict
+example_config_dict = example_config_instance.to_dict()
+# create an instance of ExampleConfig from a dict
+example_config_from_dict = ExampleConfig.from_dict(example_config_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/ExamplesConfig.md

@@ -0,0 +1,30 @@
+# ExamplesConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**examples** | [**List[ExampleConfig]**](ExampleConfig.md) | List of all the examples for Sensitive Data Rule | 
+**hint** | **str** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.examples_config import ExamplesConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExamplesConfig from a JSON string
+examples_config_instance = ExamplesConfig.from_json(json)
+# print the JSON string representation of the object
+print(ExamplesConfig.to_json())
+
+# convert the object into a dict
+examples_config_dict = examples_config_instance.to_dict()
+# create an instance of ExamplesConfig from a dict
+examples_config_from_dict = ExamplesConfig.from_dict(examples_config_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/ExtendedRole.md

@@ -0,0 +1,39 @@
+# ExtendedRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | ID of the role. | 
+**name** | **str** | Name of the role. | 
+**description** | **str** |  | 
+**organization_bindable** | **bool** | Whether the role can be bound to an organization. | 
+**workspace_bindable** | **bool** | Whether the role can be bound to a workspace. | 
+**project_bindable** | **bool** | Whether the role can be bound to a project. | 
+**data_plane_bindable** | **bool** | Whether the role can be bound to a data plane. | 
+**permissions** | [**List[Permission]**](Permission.md) | Permissions granted by the role. | 
+**base_roles** | [**List[BaseRole]**](BaseRole.md) | List of IDs of the roles this role inherits permissions from, if any. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.extended_role import ExtendedRole
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExtendedRole from a JSON string
+extended_role_instance = ExtendedRole.from_json(json)
+# print the JSON string representation of the object
+print(ExtendedRole.to_json())
+
+# convert the object into a dict
+extended_role_dict = extended_role_instance.to_dict()
+# create an instance of ExtendedRole from a dict
+extended_role_from_dict = ExtendedRole.from_dict(extended_role_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/FeatureFlagsV1Api.md

@@ -0,0 +1,73 @@
+# arthur_client.api_bindings.FeatureFlagsV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_feature_flags**](FeatureFlagsV1Api.md#get_feature_flags) | **GET** /api/v1/feature-flags | Get Feature Flags.
+
+
+# **get_feature_flags**
+> Dict[str, object] get_feature_flags()
+
+Get Feature Flags.
+
+Retrieves all feature flags in the environment.
+
+### Example
+
+
+```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"
+)
+
+
+# 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.FeatureFlagsV1Api(api_client)
+
+    try:
+        # Get Feature Flags.
+        api_response = api_instance.get_feature_flags()
+        print("The response of FeatureFlagsV1Api->get_feature_flags:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FeatureFlagsV1Api->get_feature_flags: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Dict[str, object]**
+
+### Authorization
+
+No authorization required
+
+### 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 |  -  |
+
+[[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/FetchDataJobSpec.md

@@ -0,0 +1,36 @@
+# FetchDataJobSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_type** | **str** |  | [optional] [default to 'fetch_data']
+**dataset_id** | **str** |  | [optional] 
+**available_dataset_id** | **str** |  | [optional] 
+**start_timestamp** | **datetime** | The start timestamp to use for fetching data. | 
+**end_timestamp** | **datetime** | The end timestamp to use for fetching data. | 
+**operation_id** | **str** | The id of the data retrieval operation. | 
+**data_filters** | [**List[DataResultFilter]**](DataResultFilter.md) | Filters to apply to the metrics data. | 
+**pagination_options** | [**ConnectorPaginationOptions**](ConnectorPaginationOptions.md) | Pagination options to use for fetching data. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.fetch_data_job_spec import FetchDataJobSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FetchDataJobSpec from a JSON string
+fetch_data_job_spec_instance = FetchDataJobSpec.from_json(json)
+# print the JSON string representation of the object
+print(FetchDataJobSpec.to_json())
+
+# convert the object into a dict
+fetch_data_job_spec_dict = fetch_data_job_spec_instance.to_dict()
+# create an instance of FetchDataJobSpec from a dict
+fetch_data_job_spec_from_dict = FetchDataJobSpec.from_dict(fetch_data_job_spec_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/FetchModelTaskJobSpec.md

@@ -0,0 +1,30 @@
+# FetchModelTaskJobSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_type** | **str** |  | [optional] [default to 'fetch_model_task']
+**scope_model_id** | **str** | The id of the model to fetch its corresponding task. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.fetch_model_task_job_spec import FetchModelTaskJobSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FetchModelTaskJobSpec from a JSON string
+fetch_model_task_job_spec_instance = FetchModelTaskJobSpec.from_json(json)
+# print the JSON string representation of the object
+print(FetchModelTaskJobSpec.to_json())
+
+# convert the object into a dict
+fetch_model_task_job_spec_dict = fetch_model_task_job_spec_instance.to_dict()
+# create an instance of FetchModelTaskJobSpec from a dict
+fetch_model_task_job_spec_from_dict = FetchModelTaskJobSpec.from_dict(fetch_model_task_job_spec_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/GenerateMetricsSpecRequest.md

@@ -0,0 +1,29 @@
+# GenerateMetricsSpecRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dataset_ids** | **List[str]** | List of dataset IDs for which to generate a model metrics spec. Datasets must be in the project in the path. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.generate_metrics_spec_request import GenerateMetricsSpecRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GenerateMetricsSpecRequest from a JSON string
+generate_metrics_spec_request_instance = GenerateMetricsSpecRequest.from_json(json)
+# print the JSON string representation of the object
+print(GenerateMetricsSpecRequest.to_json())
+
+# convert the object into a dict
+generate_metrics_spec_request_dict = generate_metrics_spec_request_instance.to_dict()
+# create an instance of GenerateMetricsSpecRequest from a dict
+generate_metrics_spec_request_from_dict = GenerateMetricsSpecRequest.from_dict(generate_metrics_spec_request_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/Group.md

@@ -0,0 +1,35 @@
+# Group
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | The name of the group. | 
+**description** | **str** |  | [optional] 
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | Unique group ID assigned by Arthur. | 
+**organization_id** | **str** | The ID of the organization the group belongs to. | 
+**members** | **int** | The number of members in the group. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.group import Group
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Group from a JSON string
+group_instance = Group.from_json(json)
+# print the JSON string representation of the object
+print(Group.to_json())
+
+# convert the object into a dict
+group_dict = group_instance.to_dict()
+# create an instance of Group from a dict
+group_from_dict = Group.from_dict(group_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/GroupMembership.md

@@ -0,0 +1,33 @@
+# GroupMembership
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**group** | [**Group**](Group.md) | Group info of the membership. | 
+**group_id** | **str** | The ID of the organization the group belongs to. | 
+**user_id** | **str** | The ID of the user that belongs to the group. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.group_membership import GroupMembership
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GroupMembership from a JSON string
+group_membership_instance = GroupMembership.from_json(json)
+# print the JSON string representation of the object
+print(GroupMembership.to_json())
+
+# convert the object into a dict
+group_membership_dict = group_membership_instance.to_dict()
+# create an instance of GroupMembership from a dict
+group_membership_from_dict = GroupMembership.from_dict(group_membership_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/GroupSort.md

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