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

arthur_client/api_bindings/docs/AvailableDataset.md

@@ -0,0 +1,39 @@
+# AvailableDataset
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | Unique ID of the available dataset. | 
+**connector_id** | **str** |  | [optional] 
+**project_id** | **str** | ID of parent project. | 
+**name** | **str** |  | [optional] 
+**data_plane_id** | **str** | ID of the data plane backing this dataset. | 
+**dataset_locator** | [**DatasetLocator**](DatasetLocator.md) |  | [optional] 
+**dataset_schema** | [**DatasetSchema**](DatasetSchema.md) |  | [optional] 
+**model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+**join_spec** | [**DatasetJoinSpec**](DatasetJoinSpec.md) |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.available_dataset import AvailableDataset
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AvailableDataset from a JSON string
+available_dataset_instance = AvailableDataset.from_json(json)
+# print the JSON string representation of the object
+print(AvailableDataset.to_json())
+
+# convert the object into a dict
+available_dataset_dict = available_dataset_instance.to_dict()
+# create an instance of AvailableDataset from a dict
+available_dataset_from_dict = AvailableDataset.from_dict(available_dataset_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/AvailableDatasetsSort.md

@@ -0,0 +1,14 @@
+# AvailableDatasetsSort
+
+
+## Enum
+
+* `CREATED_AT` (value: `'created_at'`)
+
+* `UPDATED_AT` (value: `'updated_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/BadRequestError.md

@@ -0,0 +1,29 @@
+# BadRequestError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | [optional] [default to 'Bad Request']
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.bad_request_error import BadRequestError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BadRequestError from a JSON string
+bad_request_error_instance = BadRequestError.from_json(json)
+# print the JSON string representation of the object
+print(BadRequestError.to_json())
+
+# convert the object into a dict
+bad_request_error_dict = bad_request_error_instance.to_dict()
+# create an instance of BadRequestError from a dict
+bad_request_error_from_dict = BadRequestError.from_dict(bad_request_error_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/BaseRole.md

@@ -0,0 +1,31 @@
+# BaseRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | ID of the role this role inherits permissions from. | 
+**name** | **str** | Name of the role this role inherits permissions from. | 
+**description** | **str** |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.base_role import BaseRole
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseRole from a JSON string
+base_role_instance = BaseRole.from_json(json)
+# print the JSON string representation of the object
+print(BaseRole.to_json())
+
+# convert the object into a dict
+base_role_dict = base_role_instance.to_dict()
+# create an instance of BaseRole from a dict
+base_role_from_dict = BaseRole.from_dict(base_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/BoundMember.md

@@ -0,0 +1,30 @@
+# BoundMember
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Id of the bound member. | 
+**name** | **str** | Name of the bound member. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.bound_member import BoundMember
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoundMember from a JSON string
+bound_member_instance = BoundMember.from_json(json)
+# print the JSON string representation of the object
+print(BoundMember.to_json())
+
+# convert the object into a dict
+bound_member_dict = bound_member_instance.to_dict()
+# create an instance of BoundMember from a dict
+bound_member_from_dict = BoundMember.from_dict(bound_member_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/BoundMemberKind.md

@@ -0,0 +1,12 @@
+# BoundMemberKind
+
+
+## Enum
+
+* `USER` (value: `'user'`)
+
+* `GROUP` (value: `'group'`)
+
+[[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/BoundResource.md

@@ -0,0 +1,31 @@
+# BoundResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | ID of the bound resource. | 
+**name** | **str** | Name of the bound resource. | 
+**metadata** | [**ProjectBoundResourceMetadata**](ProjectBoundResourceMetadata.md) |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.bound_resource import BoundResource
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoundResource from a JSON string
+bound_resource_instance = BoundResource.from_json(json)
+# print the JSON string representation of the object
+print(BoundResource.to_json())
+
+# convert the object into a dict
+bound_resource_dict = bound_resource_instance.to_dict()
+# create an instance of BoundResource from a dict
+bound_resource_from_dict = BoundResource.from_dict(bound_resource_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/BoundResourceKind.md

@@ -0,0 +1,16 @@
+# BoundResourceKind
+
+
+## Enum
+
+* `ORGANIZATION` (value: `'organization'`)
+
+* `WORKSPACE` (value: `'workspace'`)
+
+* `PROJECT` (value: `'project'`)
+
+* `DATA_PLANE` (value: `'data_plane'`)
+
+[[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/BoundRole.md

@@ -0,0 +1,30 @@
+# BoundRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | ID of the bound role. | 
+**name** | **str** | Name of the role. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.bound_role import BoundRole
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BoundRole from a JSON string
+bound_role_instance = BoundRole.from_json(json)
+# print the JSON string representation of the object
+print(BoundRole.to_json())
+
+# convert the object into a dict
+bound_role_dict = bound_role_instance.to_dict()
+# create an instance of BoundRole from a dict
+bound_role_from_dict = BoundRole.from_dict(bound_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/Config.md

@@ -0,0 +1,37 @@
+# Config
+
+Config for the rule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keywords** | **List[str]** | List of Keywords | 
+**regex_patterns** | **List[str]** | List of Regex patterns to be used for validation. Be sure to encode requests in JSON and account for escape characters. | 
+**examples** | [**List[ExampleConfig]**](ExampleConfig.md) | List of all the examples for Sensitive Data Rule | 
+**hint** | **str** |  | [optional] 
+**threshold** | **float** | Optional. Float (0, 1) indicating the level of tolerable toxicity to consider the rule passed or failed. Min: 0 (no toxic language) Max: 1 (very toxic language). Default: 0.5 | [optional] [default to 0.5]
+**disabled_pii_entities** | **List[str]** |  | [optional] 
+**confidence_threshold** | **float** |  | [optional] 
+**allow_list** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.config import Config
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Config from a JSON string
+config_instance = Config.from_json(json)
+# print the JSON string representation of the object
+print(Config.to_json())
+
+# convert the object into a dict
+config_dict = config_instance.to_dict()
+# create an instance of Config from a dict
+config_from_dict = Config.from_dict(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/ConflictError.md

@@ -0,0 +1,29 @@
+# ConflictError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | [optional] [default to 'Conflict']
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.conflict_error import ConflictError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConflictError from a JSON string
+conflict_error_instance = ConflictError.from_json(json)
+# print the JSON string representation of the object
+print(ConflictError.to_json())
+
+# convert the object into a dict
+conflict_error_dict = conflict_error_instance.to_dict()
+# create an instance of ConflictError from a dict
+conflict_error_from_dict = ConflictError.from_dict(conflict_error_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/ConnectorCheckJobSpec.md

@@ -0,0 +1,30 @@
+# ConnectorCheckJobSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**job_type** | **str** |  | [optional] [default to 'connector_check']
+**connector_id** | **str** | The id of the connector to check. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.connector_check_job_spec import ConnectorCheckJobSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectorCheckJobSpec from a JSON string
+connector_check_job_spec_instance = ConnectorCheckJobSpec.from_json(json)
+# print the JSON string representation of the object
+print(ConnectorCheckJobSpec.to_json())
+
+# convert the object into a dict
+connector_check_job_spec_dict = connector_check_job_spec_instance.to_dict()
+# create an instance of ConnectorCheckJobSpec from a dict
+connector_check_job_spec_from_dict = ConnectorCheckJobSpec.from_dict(connector_check_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/ConnectorCheckOutcome.md

@@ -0,0 +1,12 @@
+# ConnectorCheckOutcome
+
+
+## Enum
+
+* `SUCCEEDED` (value: `'succeeded'`)
+
+* `FAILED` (value: `'failed'`)
+
+[[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/ConnectorCheckResult.md

@@ -0,0 +1,30 @@
+# ConnectorCheckResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connection_check_outcome** | [**ConnectorCheckOutcome**](ConnectorCheckOutcome.md) | Result of the connector check. | 
+**failure_reason** | **str** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.connector_check_result import ConnectorCheckResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectorCheckResult from a JSON string
+connector_check_result_instance = ConnectorCheckResult.from_json(json)
+# print the JSON string representation of the object
+print(ConnectorCheckResult.to_json())
+
+# convert the object into a dict
+connector_check_result_dict = connector_check_result_instance.to_dict()
+# create an instance of ConnectorCheckResult from a dict
+connector_check_result_from_dict = ConnectorCheckResult.from_dict(connector_check_result_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/ConnectorFieldDataType.md

@@ -0,0 +1,16 @@
+# ConnectorFieldDataType
+
+
+## Enum
+
+* `STRING` (value: `'string'`)
+
+* `DICT` (value: `'dict'`)
+
+* `ENUM` (value: `'enum'`)
+
+* `INT` (value: `'int'`)
+
+[[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/ConnectorPaginationOptions.md

@@ -0,0 +1,30 @@
+# ConnectorPaginationOptions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **int** |  | [optional] [default to 1]
+**page_size** | **int** |  | [optional] [default to 25]
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.connector_pagination_options import ConnectorPaginationOptions
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectorPaginationOptions from a JSON string
+connector_pagination_options_instance = ConnectorPaginationOptions.from_json(json)
+# print the JSON string representation of the object
+print(ConnectorPaginationOptions.to_json())
+
+# convert the object into a dict
+connector_pagination_options_dict = connector_pagination_options_instance.to_dict()
+# create an instance of ConnectorPaginationOptions from a dict
+connector_pagination_options_from_dict = ConnectorPaginationOptions.from_dict(connector_pagination_options_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/ConnectorSchemasV1Api.md

@@ -0,0 +1,161 @@
+# arthur_client.api_bindings.ConnectorSchemasV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_connector_schema_by_type**](ConnectorSchemasV1Api.md#get_connector_schema_by_type) | **GET** /api/v1/connector_schemas/{connector_type} | Get Connector Schema By Type
+[**get_connector_types**](ConnectorSchemasV1Api.md#get_connector_types) | **GET** /api/v1/connector_schemas/connector_types | Get Available Connector Types
+
+
+# **get_connector_schema_by_type**
+> ConnectorSpecSchema get_connector_schema_by_type(connector_type)
+
+Get Connector Schema By Type
+
+Returns a connector schema by type.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.connector_spec_schema import ConnectorSpecSchema
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+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.ConnectorSchemasV1Api(api_client)
+    connector_type = arthur_client.api_bindings.ConnectorType() # ConnectorType | The type of the connector schema to fetch.
+
+    try:
+        # Get Connector Schema By Type
+        api_response = api_instance.get_connector_schema_by_type(connector_type)
+        print("The response of ConnectorSchemasV1Api->get_connector_schema_by_type:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ConnectorSchemasV1Api->get_connector_schema_by_type: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **connector_type** | [**ConnectorType**](.md)| The type of the connector schema to fetch. | 
+
+### Return type
+
+[**ConnectorSpecSchema**](ConnectorSpecSchema.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_connector_types**
+> ResourceListConnectorType get_connector_types()
+
+Get Available Connector Types
+
+Returns all Arthur-supported connector types.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.resource_list_connector_type import ResourceListConnectorType
+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.ConnectorSchemasV1Api(api_client)
+
+    try:
+        # Get Available Connector Types
+        api_response = api_instance.get_connector_types()
+        print("The response of ConnectorSchemasV1Api->get_connector_types:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ConnectorSchemasV1Api->get_connector_types: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ResourceListConnectorType**](ResourceListConnectorType.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 |  -  |
+
+[[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/ConnectorSpec.md

@@ -0,0 +1,39 @@
+# ConnectorSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | Connector id. | 
+**connector_type** | [**ConnectorType**](ConnectorType.md) | Type of connector. | 
+**name** | **str** | Name of connector. | 
+**temporary** | **bool** | True if connector is temporary (ie for testing only), false otherwise. | 
+**fields** | [**List[ConnectorSpecFieldWithMetadata]**](ConnectorSpecFieldWithMetadata.md) | List of fields for the connector. | 
+**last_updated_by_user** | [**User**](User.md) |  | [optional] 
+**connector_check_result** | [**ConnectorCheckResult**](ConnectorCheckResult.md) |  | [optional] 
+**project_id** | **str** | ID of parent project. | 
+**data_plane_id** | **str** | ID of the data plane that will execute the connection. Should be formatted as a UUID. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.connector_spec import ConnectorSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectorSpec from a JSON string
+connector_spec_instance = ConnectorSpec.from_json(json)
+# print the JSON string representation of the object
+print(ConnectorSpec.to_json())
+
+# convert the object into a dict
+connector_spec_dict = connector_spec_instance.to_dict()
+# create an instance of ConnectorSpec from a dict
+connector_spec_from_dict = ConnectorSpec.from_dict(connector_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/ConnectorSpecField.md

@@ -0,0 +1,30 @@
+# ConnectorSpecField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **str** | Name of connector field. | 
+**value** | **str** | Value of connector field. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.connector_spec_field import ConnectorSpecField
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ConnectorSpecField from a JSON string
+connector_spec_field_instance = ConnectorSpecField.from_json(json)
+# print the JSON string representation of the object
+print(ConnectorSpecField.to_json())
+
+# convert the object into a dict
+connector_spec_field_dict = connector_spec_field_instance.to_dict()
+# create an instance of ConnectorSpecField from a dict
+connector_spec_field_from_dict = ConnectorSpecField.from_dict(connector_spec_field_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)
+
+