workato-platform-cli 1.0.0rc5.dev5__py3-none-any.whl

workato_platform_cli/client/workato_api/docs/RecipesApi.md

@@ -0,0 +1,367 @@
+# workato_platform_cli.client.workato_api.RecipesApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_recipes**](RecipesApi.md#list_recipes) | **GET** /api/recipes | List recipes
+[**start_recipe**](RecipesApi.md#start_recipe) | **PUT** /api/recipes/{recipe_id}/start | Start a recipe
+[**stop_recipe**](RecipesApi.md#stop_recipe) | **PUT** /api/recipes/{recipe_id}/stop | Stop a recipe
+[**update_recipe_connection**](RecipesApi.md#update_recipe_connection) | **PUT** /api/recipes/{recipe_id}/connect | Update a connection for a recipe
+
+
+# **list_recipes**
+> RecipeListResponse list_recipes(adapter_names_all=adapter_names_all, adapter_names_any=adapter_names_any, folder_id=folder_id, order=order, page=page, per_page=per_page, running=running, since_id=since_id, stopped_after=stopped_after, stop_cause=stop_cause, updated_after=updated_after, includes=includes, exclude_code=exclude_code)
+
+List recipes
+
+Returns a list of recipes belonging to the authenticated user.
+Recipes are returned in descending ID order.
+
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.recipe_list_response import RecipeListResponse
+from workato_platform_cli.client.workato_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://www.workato.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    host = "https://www.workato.com"
+)
+
+# 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: BearerAuth
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = workato_platform_cli.client.workato_api.RecipesApi(api_client)
+    adapter_names_all = 'adapter_names_all_example' # str | Comma-separated adapter names (recipes must use ALL) (optional)
+    adapter_names_any = 'adapter_names_any_example' # str | Comma-separated adapter names (recipes must use ANY) (optional)
+    folder_id = 56 # int | Return recipes in specified folder (optional)
+    order = 'order_example' # str | Set ordering method (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    per_page = 100 # int | Number of recipes per page (optional) (default to 100)
+    running = True # bool | If true, returns only running recipes (optional)
+    since_id = 56 # int | Return recipes with IDs lower than this value (optional)
+    stopped_after = '2013-10-20T19:20:30+01:00' # datetime | Exclude recipes stopped after this date (ISO 8601 format) (optional)
+    stop_cause = 'stop_cause_example' # str | Filter by stop reason (optional)
+    updated_after = '2013-10-20T19:20:30+01:00' # datetime | Include recipes updated after this date (ISO 8601 format) (optional)
+    includes = ['includes_example'] # List[str] | Additional fields to include (e.g., tags) (optional)
+    exclude_code = True # bool | Exclude recipe code from response for better performance (optional)
+
+    try:
+        # List recipes
+        api_response = await api_instance.list_recipes(adapter_names_all=adapter_names_all, adapter_names_any=adapter_names_any, folder_id=folder_id, order=order, page=page, per_page=per_page, running=running, since_id=since_id, stopped_after=stopped_after, stop_cause=stop_cause, updated_after=updated_after, includes=includes, exclude_code=exclude_code)
+        print("The response of RecipesApi->list_recipes:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling RecipesApi->list_recipes: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **adapter_names_all** | **str**| Comma-separated adapter names (recipes must use ALL) | [optional] 
+ **adapter_names_any** | **str**| Comma-separated adapter names (recipes must use ANY) | [optional] 
+ **folder_id** | **int**| Return recipes in specified folder | [optional] 
+ **order** | **str**| Set ordering method | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **per_page** | **int**| Number of recipes per page | [optional] [default to 100]
+ **running** | **bool**| If true, returns only running recipes | [optional] 
+ **since_id** | **int**| Return recipes with IDs lower than this value | [optional] 
+ **stopped_after** | **datetime**| Exclude recipes stopped after this date (ISO 8601 format) | [optional] 
+ **stop_cause** | **str**| Filter by stop reason | [optional] 
+ **updated_after** | **datetime**| Include recipes updated after this date (ISO 8601 format) | [optional] 
+ **includes** | [**List[str]**](str.md)| Additional fields to include (e.g., tags) | [optional] 
+ **exclude_code** | **bool**| Exclude recipe code from response for better performance | [optional] 
+
+### Return type
+
+[**RecipeListResponse**](RecipeListResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | List of recipes retrieved successfully |  -  |
+**401** | Authentication required |  -  |
+
+[[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)
+
+# **start_recipe**
+> RecipeStartResponse start_recipe(recipe_id)
+
+Start a recipe
+
+Starts a recipe specified by recipe ID
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.recipe_start_response import RecipeStartResponse
+from workato_platform_cli.client.workato_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://www.workato.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    host = "https://www.workato.com"
+)
+
+# 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: BearerAuth
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = workato_platform_cli.client.workato_api.RecipesApi(api_client)
+    recipe_id = 56 # int | Recipe ID
+
+    try:
+        # Start a recipe
+        api_response = await api_instance.start_recipe(recipe_id)
+        print("The response of RecipesApi->start_recipe:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling RecipesApi->start_recipe: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipe_id** | **int**| Recipe ID | 
+
+### Return type
+
+[**RecipeStartResponse**](RecipeStartResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Recipe start response (success or validation failure) |  -  |
+**400** | Bad request (OEM adapter usage limit or state transition error) |  -  |
+**401** | Authentication required |  -  |
+**422** | Unprocessable entity (webhook registration error) |  -  |
+**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)
+
+# **stop_recipe**
+> SuccessResponse stop_recipe(recipe_id)
+
+Stop a recipe
+
+Stops a recipe specified by recipe ID
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.success_response import SuccessResponse
+from workato_platform_cli.client.workato_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://www.workato.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    host = "https://www.workato.com"
+)
+
+# 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: BearerAuth
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = workato_platform_cli.client.workato_api.RecipesApi(api_client)
+    recipe_id = 56 # int | Recipe ID
+
+    try:
+        # Stop a recipe
+        api_response = await api_instance.stop_recipe(recipe_id)
+        print("The response of RecipesApi->stop_recipe:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling RecipesApi->stop_recipe: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipe_id** | **int**| Recipe ID | 
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Recipe stopped successfully |  -  |
+**400** | Bad request (state transition error or recipe cannot be stopped) |  -  |
+**401** | Authentication required |  -  |
+**404** | Recipe 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)
+
+# **update_recipe_connection**
+> SuccessResponse update_recipe_connection(recipe_id, recipe_connection_update_request)
+
+Update a connection for a recipe
+
+Updates the chosen connection for a specific connector in a stopped recipe.
+
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.recipe_connection_update_request import RecipeConnectionUpdateRequest
+from workato_platform_cli.client.workato_api.models.success_response import SuccessResponse
+from workato_platform_cli.client.workato_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://www.workato.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    host = "https://www.workato.com"
+)
+
+# 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: BearerAuth
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = workato_platform_cli.client.workato_api.RecipesApi(api_client)
+    recipe_id = 56 # int | ID of the recipe
+    recipe_connection_update_request = workato_platform_cli.client.workato_api.RecipeConnectionUpdateRequest() # RecipeConnectionUpdateRequest | 
+
+    try:
+        # Update a connection for a recipe
+        api_response = await api_instance.update_recipe_connection(recipe_id, recipe_connection_update_request)
+        print("The response of RecipesApi->update_recipe_connection:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling RecipesApi->update_recipe_connection: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipe_id** | **int**| ID of the recipe | 
+ **recipe_connection_update_request** | [**RecipeConnectionUpdateRequest**](RecipeConnectionUpdateRequest.md)|  | 
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Connection updated successfully |  -  |
+**400** | Bad request (recipe is running or invalid parameters) |  -  |
+**401** | Authentication required |  -  |
+**403** | Forbidden (no permission to update this recipe) |  -  |
+**404** | Recipe not found |  -  |
+
+[[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)
+

workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionCreateRequest.md

@@ -0,0 +1,34 @@
+# RuntimeUserConnectionCreateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_id** | **int** | ID of parent OAuth connector (connection must be established) | 
+**name** | **str** | Optional name for the runtime user connection | [optional] 
+**folder_id** | **int** | Folder to put connection (uses current project if not specified) | 
+**external_id** | **str** | End user string ID for identifying the connection | 
+**callback_url** | **str** | Optional URL called back after successful token acquisition | [optional] 
+**redirect_url** | **str** | Optional URL where user is redirected after successful authorization | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_create_request import RuntimeUserConnectionCreateRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RuntimeUserConnectionCreateRequest from a JSON string
+runtime_user_connection_create_request_instance = RuntimeUserConnectionCreateRequest.from_json(json)
+# print the JSON string representation of the object
+print(RuntimeUserConnectionCreateRequest.to_json())
+
+# convert the object into a dict
+runtime_user_connection_create_request_dict = runtime_user_connection_create_request_instance.to_dict()
+# create an instance of RuntimeUserConnectionCreateRequest from a dict
+runtime_user_connection_create_request_from_dict = RuntimeUserConnectionCreateRequest.from_dict(runtime_user_connection_create_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)
+
+

workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponse.md

@@ -0,0 +1,29 @@
+# RuntimeUserConnectionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**RuntimeUserConnectionResponseData**](RuntimeUserConnectionResponseData.md) |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_response import RuntimeUserConnectionResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RuntimeUserConnectionResponse from a JSON string
+runtime_user_connection_response_instance = RuntimeUserConnectionResponse.from_json(json)
+# print the JSON string representation of the object
+print(RuntimeUserConnectionResponse.to_json())
+
+# convert the object into a dict
+runtime_user_connection_response_dict = runtime_user_connection_response_instance.to_dict()
+# create an instance of RuntimeUserConnectionResponse from a dict
+runtime_user_connection_response_from_dict = RuntimeUserConnectionResponse.from_dict(runtime_user_connection_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)
+
+

workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponseData.md

@@ -0,0 +1,30 @@
+# RuntimeUserConnectionResponseData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The ID of the created runtime user connection | 
+**url** | **str** | OAuth URL for user authorization | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_response_data import RuntimeUserConnectionResponseData
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RuntimeUserConnectionResponseData from a JSON string
+runtime_user_connection_response_data_instance = RuntimeUserConnectionResponseData.from_json(json)
+# print the JSON string representation of the object
+print(RuntimeUserConnectionResponseData.to_json())
+
+# convert the object into a dict
+runtime_user_connection_response_data_dict = runtime_user_connection_response_data_instance.to_dict()
+# create an instance of RuntimeUserConnectionResponseData from a dict
+runtime_user_connection_response_data_from_dict = RuntimeUserConnectionResponseData.from_dict(runtime_user_connection_response_data_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)
+
+

workato_platform_cli/client/workato_api/docs/SuccessResponse.md

@@ -0,0 +1,29 @@
+# SuccessResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.success_response import SuccessResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of SuccessResponse from a JSON string
+success_response_instance = SuccessResponse.from_json(json)
+# print the JSON string representation of the object
+print(SuccessResponse.to_json())
+
+# convert the object into a dict
+success_response_dict = success_response_instance.to_dict()
+# create an instance of SuccessResponse from a dict
+success_response_from_dict = SuccessResponse.from_dict(success_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)
+
+

workato_platform_cli/client/workato_api/docs/UpsertProjectPropertiesRequest.md

@@ -0,0 +1,29 @@
+# UpsertProjectPropertiesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | **Dict[str, str]** | Contains the names and values of the properties you plan to upsert. Property names are limited to 100 characters, values to 1,024 characters.  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.upsert_project_properties_request import UpsertProjectPropertiesRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of UpsertProjectPropertiesRequest from a JSON string
+upsert_project_properties_request_instance = UpsertProjectPropertiesRequest.from_json(json)
+# print the JSON string representation of the object
+print(UpsertProjectPropertiesRequest.to_json())
+
+# convert the object into a dict
+upsert_project_properties_request_dict = upsert_project_properties_request_instance.to_dict()
+# create an instance of UpsertProjectPropertiesRequest from a dict
+upsert_project_properties_request_from_dict = UpsertProjectPropertiesRequest.from_dict(upsert_project_properties_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)
+
+

workato_platform_cli/client/workato_api/docs/User.md

@@ -0,0 +1,48 @@
+# User
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**name** | **str** |  | 
+**created_at** | **datetime** |  | 
+**plan_id** | **str** |  | 
+**current_billing_period_start** | **datetime** |  | 
+**current_billing_period_end** | **datetime** |  | 
+**expert** | **bool** |  | [optional] 
+**avatar_url** | **str** |  | [optional] 
+**recipes_count** | **int** |  | 
+**interested_applications** | **List[str]** |  | [optional] 
+**company_name** | **str** |  | 
+**location** | **str** |  | 
+**last_seen** | **datetime** |  | 
+**contact_phone** | **str** |  | [optional] 
+**contact_email** | **str** |  | [optional] 
+**about_me** | **str** |  | [optional] 
+**email** | **str** |  | 
+**phone** | **str** |  | [optional] 
+**active_recipes_count** | **int** |  | 
+**root_folder_id** | **int** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.user import User
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of User from a JSON string
+user_instance = User.from_json(json)
+# print the JSON string representation of the object
+print(User.to_json())
+
+# convert the object into a dict
+user_dict = user_instance.to_dict()
+# create an instance of User from a dict
+user_from_dict = User.from_dict(user_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)
+
+

workato_platform_cli/client/workato_api/docs/UsersApi.md

@@ -0,0 +1,84 @@
+# workato_platform_cli.client.workato_api.UsersApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_workspace_details**](UsersApi.md#get_workspace_details) | **GET** /api/users/me | Get current user information
+
+
+# **get_workspace_details**
+> User get_workspace_details()
+
+Get current user information
+
+Returns information about the authenticated user
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.user import User
+from workato_platform_cli.client.workato_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://www.workato.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    host = "https://www.workato.com"
+)
+
+# 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: BearerAuth
+configuration = workato_platform_cli.client.workato_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = workato_platform_cli.client.workato_api.UsersApi(api_client)
+
+    try:
+        # Get current user information
+        api_response = await api_instance.get_workspace_details()
+        print("The response of UsersApi->get_workspace_details:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->get_workspace_details: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | User information retrieved successfully |  -  |
+**401** | Authentication required |  -  |
+
+[[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)
+

workato_platform_cli/client/workato_api/docs/ValidationError.md

@@ -0,0 +1,30 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** |  | [optional] 
+**errors** | [**Dict[str, ValidationErrorErrorsValue]**](ValidationErrorErrorsValue.md) |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.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)
+
+