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

arthur_client/api_bindings/docs/ValidationError.md

@@ -0,0 +1,31 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) |  | 
+**msg** | **str** |  | 
+**type** | **str** |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.validation_error import ValidationError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationError from a JSON string
+validation_error_instance = ValidationError.from_json(json)
+# print the JSON string representation of the object
+print(ValidationError.to_json())
+
+# convert the object into a dict
+validation_error_dict = validation_error_instance.to_dict()
+# create an instance of ValidationError from a dict
+validation_error_from_dict = ValidationError.from_dict(validation_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/ValidationErrorLocInner.md

@@ -0,0 +1,28 @@
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.validation_error_loc_inner import ValidationErrorLocInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationErrorLocInner from a JSON string
+validation_error_loc_inner_instance = ValidationErrorLocInner.from_json(json)
+# print the JSON string representation of the object
+print(ValidationErrorLocInner.to_json())
+
+# convert the object into a dict
+validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict()
+# create an instance of ValidationErrorLocInner from a dict
+validation_error_loc_inner_from_dict = ValidationErrorLocInner.from_dict(validation_error_loc_inner_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/Webhook.md

@@ -0,0 +1,37 @@
+# Webhook
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of webhook. | 
+**url** | **str** | URL of the webhook. | 
+**headers** | **Dict[str, List[str]]** | List of headers for the webhook. | [optional] 
+**body** | **str** | Body of the webhook. | 
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | The id of the webhook. | 
+**workspace_id** | **str** | ID of the parent workspace. | 
+**last_updated_by_user** | [**User**](User.md) |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.webhook import Webhook
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Webhook from a JSON string
+webhook_instance = Webhook.from_json(json)
+# print the JSON string representation of the object
+print(Webhook.to_json())
+
+# convert the object into a dict
+webhook_dict = webhook_instance.to_dict()
+# create an instance of Webhook from a dict
+webhook_from_dict = Webhook.from_dict(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/WebhookResponse.md

@@ -0,0 +1,30 @@
+# WebhookResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status_code** | **int** |  | 
+**response** | **str** |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.webhook_response import WebhookResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of WebhookResponse from a JSON string
+webhook_response_instance = WebhookResponse.from_json(json)
+# print the JSON string representation of the object
+print(WebhookResponse.to_json())
+
+# convert the object into a dict
+webhook_response_dict = webhook_response_instance.to_dict()
+# create an instance of WebhookResponse from a dict
+webhook_response_from_dict = WebhookResponse.from_dict(webhook_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)
+
+

arthur_client/api_bindings/docs/WebhookResult.md

@@ -0,0 +1,30 @@
+# WebhookResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **str** |  | 
+**response** | [**WebhookResponse**](WebhookResponse.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.webhook_result import WebhookResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of WebhookResult from a JSON string
+webhook_result_instance = WebhookResult.from_json(json)
+# print the JSON string representation of the object
+print(WebhookResult.to_json())
+
+# convert the object into a dict
+webhook_result_dict = webhook_result_instance.to_dict()
+# create an instance of WebhookResult from a dict
+webhook_result_from_dict = WebhookResult.from_dict(webhook_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/WebhookSort.md

@@ -0,0 +1,14 @@
+# WebhookSort
+
+
+## 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/WebhooksV1Api.md

@@ -0,0 +1,503 @@
+# arthur_client.api_bindings.WebhooksV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_webhook**](WebhooksV1Api.md#delete_webhook) | **DELETE** /api/v1/webhooks/{webhook_id} | Delete Webhook.
+[**get_webhook**](WebhooksV1Api.md#get_webhook) | **GET** /api/v1/webhooks/{webhook_id} | Get Webhook.
+[**get_workspace_webhooks**](WebhooksV1Api.md#get_workspace_webhooks) | **GET** /api/v1/workspaces/{workspace_id}/webhooks | Get Webhooks.
+[**patch_webhook**](WebhooksV1Api.md#patch_webhook) | **PATCH** /api/v1/webhooks/{webhook_id} | Patch Webhook.
+[**post_test_webhook**](WebhooksV1Api.md#post_test_webhook) | **POST** /api/v1/workspaces/{workspace_id}/webhooks/test | Post Test Webhook.
+[**post_webhook**](WebhooksV1Api.md#post_webhook) | **POST** /api/v1/workspaces/{workspace_id}/webhooks | Post Webhook.
+
+
+# **delete_webhook**
+> delete_webhook(webhook_id)
+
+Delete Webhook.
+
+Requires webhook_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.WebhooksV1Api(api_client)
+    webhook_id = 'webhook_id_example' # str | 
+
+    try:
+        # Delete Webhook.
+        api_instance.delete_webhook(webhook_id)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->delete_webhook: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_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 |  -  |
+**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)
+
+# **get_webhook**
+> Webhook get_webhook(webhook_id)
+
+Get Webhook.
+
+Requires webhook_read permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.webhook import Webhook
+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.WebhooksV1Api(api_client)
+    webhook_id = 'webhook_id_example' # str | 
+
+    try:
+        # Get Webhook.
+        api_response = api_instance.get_webhook(webhook_id)
+        print("The response of WebhooksV1Api->get_webhook:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->get_webhook: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **str**|  | 
+
+### Return type
+
+[**Webhook**](Webhook.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_workspace_webhooks**
+> ResourceListWebhook get_workspace_webhooks(workspace_id, sort=sort, order=order, name=name, page=page, page_size=page_size)
+
+Get Webhooks.
+
+Return a list of webhooks associated with a workspace. Requires workspace_list_webhooks permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.resource_list_webhook import ResourceListWebhook
+from arthur_client.api_bindings.models.sort_order import SortOrder
+from arthur_client.api_bindings.models.webhook_sort import WebhookSort
+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.WebhooksV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    sort = arthur_client.api_bindings.WebhookSort() # WebhookSort | Override the field used for sorting the returned list. Optional. (optional)
+    order = arthur_client.api_bindings.SortOrder() # SortOrder | Override the sort order used. Optional. (optional)
+    name = 'name_example' # str | Search term to filter webhooks by name. (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 Webhooks.
+        api_response = api_instance.get_workspace_webhooks(workspace_id, sort=sort, order=order, name=name, page=page, page_size=page_size)
+        print("The response of WebhooksV1Api->get_workspace_webhooks:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->get_workspace_webhooks: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **sort** | [**WebhookSort**](.md)| Override the field used for sorting the returned list. Optional. | [optional] 
+ **order** | [**SortOrder**](.md)| Override the sort order used. Optional. | [optional] 
+ **name** | **str**| Search term to filter webhooks by name. | [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
+
+[**ResourceListWebhook**](ResourceListWebhook.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_webhook**
+> Webhook patch_webhook(webhook_id, patch_webhook)
+
+Patch Webhook.
+
+Requires webhook_update permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.patch_webhook import PatchWebhook
+from arthur_client.api_bindings.models.webhook import Webhook
+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.WebhooksV1Api(api_client)
+    webhook_id = 'webhook_id_example' # str | 
+    patch_webhook = arthur_client.api_bindings.PatchWebhook() # PatchWebhook | 
+
+    try:
+        # Patch Webhook.
+        api_response = api_instance.patch_webhook(webhook_id, patch_webhook)
+        print("The response of WebhooksV1Api->patch_webhook:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->patch_webhook: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **str**|  | 
+ **patch_webhook** | [**PatchWebhook**](PatchWebhook.md)|  | 
+
+### Return type
+
+[**Webhook**](Webhook.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 |  -  |
+**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_test_webhook**
+> WebhookResult post_test_webhook(workspace_id, post_webhook)
+
+Post Test Webhook.
+
+Tests a webhook in a given workspace. Requires workspace_test_webhook permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.post_webhook import PostWebhook
+from arthur_client.api_bindings.models.webhook_result import WebhookResult
+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.WebhooksV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    post_webhook = arthur_client.api_bindings.PostWebhook() # PostWebhook | 
+
+    try:
+        # Post Test Webhook.
+        api_response = api_instance.post_test_webhook(workspace_id, post_webhook)
+        print("The response of WebhooksV1Api->post_test_webhook:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->post_test_webhook: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **post_webhook** | [**PostWebhook**](PostWebhook.md)|  | 
+
+### Return type
+
+[**WebhookResult**](WebhookResult.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 |  -  |
+**400** | Bad Request |  -  |
+**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)
+
+# **post_webhook**
+> Webhook post_webhook(workspace_id, post_webhook)
+
+Post Webhook.
+
+Creates a webhook in a given workspace. Requires workspace_create_webhook permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.post_webhook import PostWebhook
+from arthur_client.api_bindings.models.webhook import Webhook
+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.WebhooksV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    post_webhook = arthur_client.api_bindings.PostWebhook() # PostWebhook | 
+
+    try:
+        # Post Webhook.
+        api_response = api_instance.post_webhook(workspace_id, post_webhook)
+        print("The response of WebhooksV1Api->post_webhook:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling WebhooksV1Api->post_webhook: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **post_webhook** | [**PostWebhook**](PostWebhook.md)|  | 
+
+### Return type
+
+[**Webhook**](Webhook.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 |  -  |
+**400** | Bad Request |  -  |
+**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)
+