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

workato_platform_cli/client/workato_api/docs/ProjectsApi.md

@@ -0,0 +1,173 @@
+# workato_platform_cli.client.workato_api.ProjectsApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_project**](ProjectsApi.md#delete_project) | **DELETE** /api/projects/{project_id} | Delete a project
+[**list_projects**](ProjectsApi.md#list_projects) | **GET** /api/projects | List projects
+
+
+# **delete_project**
+> SuccessResponse delete_project(project_id)
+
+Delete a project
+
+Delete a project and all of its contents. This includes all child folders,
+recipes, connections, and Workflow apps assets inside the project.
+
+
+### 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.ProjectsApi(api_client)
+    project_id = 56 # int | The ID of the project to delete
+
+    try:
+        # Delete a project
+        api_response = await api_instance.delete_project(project_id)
+        print("The response of ProjectsApi->delete_project:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ProjectsApi->delete_project: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **int**| The ID of the project to delete | 
+
+### 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** | Project deleted successfully |  -  |
+**401** | Authentication required |  -  |
+**403** | Permission denied |  -  |
+
+[[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)
+
+# **list_projects**
+> List[Project] list_projects(page=page, per_page=per_page)
+
+List projects
+
+Returns a list of projects belonging to the authenticated user with pagination support
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.project import Project
+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.ProjectsApi(api_client)
+    page = 1 # int | Page number (optional) (default to 1)
+    per_page = 100 # int | Number of projects per page (optional) (default to 100)
+
+    try:
+        # List projects
+        api_response = await api_instance.list_projects(page=page, per_page=per_page)
+        print("The response of ProjectsApi->list_projects:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ProjectsApi->list_projects: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| Page number | [optional] [default to 1]
+ **per_page** | **int**| Number of projects per page | [optional] [default to 100]
+
+### Return type
+
+[**List[Project]**](Project.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 projects 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/PropertiesApi.md

@@ -0,0 +1,186 @@
+# workato_platform_cli.client.workato_api.PropertiesApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_project_properties**](PropertiesApi.md#list_project_properties) | **GET** /api/properties | List project properties
+[**upsert_project_properties**](PropertiesApi.md#upsert_project_properties) | **POST** /api/properties | Upsert project properties
+
+
+# **list_project_properties**
+> Dict[str, str] list_project_properties(prefix, project_id)
+
+List project properties
+
+Returns a list of project-level properties belonging to a specific project in a
+customer workspace that matches a project_id you specify. You must also include
+a prefix. For example, if you provide the prefix salesforce_sync., any project
+property with a name beginning with salesforce_sync., such as
+salesforce_sync.admin_email, with the project_id you provided is returned.
+
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+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.PropertiesApi(api_client)
+    prefix = 'salesforce_sync.' # str | Returns properties that contain the prefix you provided. For example, if the prefix is salesforce_sync. the property salesforce_sync.admin_email is returned. 
+    project_id = 523144 # int | Returns project-level properties that match the project_id you specify. If this parameter is not present, this call returns environment properties. 
+
+    try:
+        # List project properties
+        api_response = await api_instance.list_project_properties(prefix, project_id)
+        print("The response of PropertiesApi->list_project_properties:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PropertiesApi->list_project_properties: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **prefix** | **str**| Returns properties that contain the prefix you provided. For example, if the prefix is salesforce_sync. the property salesforce_sync.admin_email is returned.  | 
+ **project_id** | **int**| Returns project-level properties that match the project_id you specify. If this parameter is not present, this call returns environment properties.  | 
+
+### Return type
+
+**Dict[str, str]**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Project properties 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)
+
+# **upsert_project_properties**
+> SuccessResponse upsert_project_properties(project_id, upsert_project_properties_request)
+
+Upsert project properties
+
+Upserts project properties belonging to a specific project in a customer workspace
+that matches a project_id you specify. This endpoint maps to properties based on
+the names you provide in the request.
+
+## Property Limits
+- Maximum number of project properties per project: 1,000
+- Maximum length of project property name: 100 characters
+- Maximum length of project property value: 1,024 characters
+
+
+### 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.models.upsert_project_properties_request import UpsertProjectPropertiesRequest
+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.PropertiesApi(api_client)
+    project_id = 523144 # int | Provide the project ID that contains the project properties you plan to upsert. If this parameter is not present, this call upserts environment properties. 
+    upsert_project_properties_request = workato_platform_cli.client.workato_api.UpsertProjectPropertiesRequest() # UpsertProjectPropertiesRequest | 
+
+    try:
+        # Upsert project properties
+        api_response = await api_instance.upsert_project_properties(project_id, upsert_project_properties_request)
+        print("The response of PropertiesApi->upsert_project_properties:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling PropertiesApi->upsert_project_properties: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **int**| Provide the project ID that contains the project properties you plan to upsert. If this parameter is not present, this call upserts environment properties.  | 
+ **upsert_project_properties_request** | [**UpsertProjectPropertiesRequest**](UpsertProjectPropertiesRequest.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** | Project properties upserted successfully |  -  |
+**400** | Bad request |  -  |
+**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/Recipe.md

@@ -0,0 +1,58 @@
+# Recipe
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**user_id** | **int** |  | 
+**name** | **str** |  | 
+**created_at** | **datetime** |  | 
+**updated_at** | **datetime** |  | 
+**copy_count** | **int** |  | 
+**trigger_application** | **str** |  | [optional] 
+**action_applications** | **List[str]** |  | 
+**applications** | **List[str]** |  | 
+**description** | **str** |  | 
+**parameters_schema** | **List[object]** |  | 
+**parameters** | **object** |  | 
+**webhook_url** | **str** |  | 
+**folder_id** | **int** |  | 
+**running** | **bool** |  | 
+**job_succeeded_count** | **int** |  | 
+**job_failed_count** | **int** |  | 
+**lifetime_task_count** | **int** |  | 
+**last_run_at** | **datetime** |  | [optional] 
+**stopped_at** | **datetime** |  | [optional] 
+**version_no** | **int** |  | 
+**stop_cause** | **str** |  | 
+**config** | [**List[RecipeConfigInner]**](RecipeConfigInner.md) |  | 
+**trigger_closure** | **object** |  | 
+**code** | **str** | Recipe code (may be truncated if exclude_code is true) | 
+**author_name** | **str** |  | 
+**version_author_name** | **str** |  | 
+**version_author_email** | **str** |  | 
+**version_comment** | **str** |  | 
+**tags** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.recipe import Recipe
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Recipe from a JSON string
+recipe_instance = Recipe.from_json(json)
+# print the JSON string representation of the object
+print(Recipe.to_json())
+
+# convert the object into a dict
+recipe_dict = recipe_instance.to_dict()
+# create an instance of Recipe from a dict
+recipe_from_dict = Recipe.from_dict(recipe_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/RecipeConfigInner.md

@@ -0,0 +1,33 @@
+# RecipeConfigInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keyword** | **str** |  | [optional] 
+**name** | **str** |  | [optional] 
+**provider** | **str** |  | [optional] 
+**skip_validation** | **bool** |  | [optional] 
+**account_id** | **int** |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.recipe_config_inner import RecipeConfigInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RecipeConfigInner from a JSON string
+recipe_config_inner_instance = RecipeConfigInner.from_json(json)
+# print the JSON string representation of the object
+print(RecipeConfigInner.to_json())
+
+# convert the object into a dict
+recipe_config_inner_dict = recipe_config_inner_instance.to_dict()
+# create an instance of RecipeConfigInner from a dict
+recipe_config_inner_from_dict = RecipeConfigInner.from_dict(recipe_config_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)
+
+

workato_platform_cli/client/workato_api/docs/RecipeConnectionUpdateRequest.md

@@ -0,0 +1,30 @@
+# RecipeConnectionUpdateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adapter_name** | **str** | The internal name of the connector | 
+**connection_id** | **int** | The ID of the connection that replaces the existing one | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.recipe_connection_update_request import RecipeConnectionUpdateRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RecipeConnectionUpdateRequest from a JSON string
+recipe_connection_update_request_instance = RecipeConnectionUpdateRequest.from_json(json)
+# print the JSON string representation of the object
+print(RecipeConnectionUpdateRequest.to_json())
+
+# convert the object into a dict
+recipe_connection_update_request_dict = recipe_connection_update_request_instance.to_dict()
+# create an instance of RecipeConnectionUpdateRequest from a dict
+recipe_connection_update_request_from_dict = RecipeConnectionUpdateRequest.from_dict(recipe_connection_update_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/RecipeListResponse.md

@@ -0,0 +1,29 @@
+# RecipeListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Recipe]**](Recipe.md) |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.recipe_list_response import RecipeListResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RecipeListResponse from a JSON string
+recipe_list_response_instance = RecipeListResponse.from_json(json)
+# print the JSON string representation of the object
+print(RecipeListResponse.to_json())
+
+# convert the object into a dict
+recipe_list_response_dict = recipe_list_response_instance.to_dict()
+# create an instance of RecipeListResponse from a dict
+recipe_list_response_from_dict = RecipeListResponse.from_dict(recipe_list_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/RecipeStartResponse.md

@@ -0,0 +1,31 @@
+# RecipeStartResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** | Indicates whether the recipe started successfully | 
+**code_errors** | **List[List[object]]** | Code validation errors (only present on failure) | [optional] 
+**config_errors** | **List[List[object]]** | Configuration errors (only present on failure) | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.recipe_start_response import RecipeStartResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of RecipeStartResponse from a JSON string
+recipe_start_response_instance = RecipeStartResponse.from_json(json)
+# print the JSON string representation of the object
+print(RecipeStartResponse.to_json())
+
+# convert the object into a dict
+recipe_start_response_dict = recipe_start_response_instance.to_dict()
+# create an instance of RecipeStartResponse from a dict
+recipe_start_response_from_dict = RecipeStartResponse.from_dict(recipe_start_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)
+
+