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

workato_platform_cli/client/workato_api/docs/FoldersApi.md

@@ -0,0 +1,176 @@
+# workato_platform_cli.client.workato_api.FoldersApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_folder**](FoldersApi.md#create_folder) | **POST** /api/folders | Create a folder
+[**list_folders**](FoldersApi.md#list_folders) | **GET** /api/folders | List folders
+
+
+# **create_folder**
+> FolderCreationResponse create_folder(create_folder_request)
+
+Create a folder
+
+Creates a new folder in the specified parent folder. If no parent folder ID
+is specified, creates the folder as a top-level folder in the home folder.
+
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.create_folder_request import CreateFolderRequest
+from workato_platform_cli.client.workato_api.models.folder_creation_response import FolderCreationResponse
+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.FoldersApi(api_client)
+    create_folder_request = workato_platform_cli.client.workato_api.CreateFolderRequest() # CreateFolderRequest | 
+
+    try:
+        # Create a folder
+        api_response = await api_instance.create_folder(create_folder_request)
+        print("The response of FoldersApi->create_folder:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FoldersApi->create_folder: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_folder_request** | [**CreateFolderRequest**](CreateFolderRequest.md)|  | 
+
+### Return type
+
+[**FolderCreationResponse**](FolderCreationResponse.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** | Folder created 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)
+
+# **list_folders**
+> List[Folder] list_folders(parent_id=parent_id, page=page, per_page=per_page)
+
+List folders
+
+Lists all folders.
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.folder import Folder
+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.FoldersApi(api_client)
+    parent_id = 56 # int | Parent folder ID. Defaults to Home folder. (optional)
+    page = 1 # int | Page number. Defaults to 1. (optional) (default to 1)
+    per_page = 100 # int | Page size. Defaults to 100 (maximum is 100). (optional) (default to 100)
+
+    try:
+        # List folders
+        api_response = await api_instance.list_folders(parent_id=parent_id, page=page, per_page=per_page)
+        print("The response of FoldersApi->list_folders:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FoldersApi->list_folders: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent_id** | **int**| Parent folder ID. Defaults to Home folder. | [optional] 
+ **page** | **int**| Page number. Defaults to 1. | [optional] [default to 1]
+ **per_page** | **int**| Page size. Defaults to 100 (maximum is 100). | [optional] [default to 100]
+
+### Return type
+
+[**List[Folder]**](Folder.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 folders 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/ImportResults.md

@@ -0,0 +1,32 @@
+# ImportResults
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** |  | 
+**total_endpoints** | **int** |  | 
+**failed_endpoints** | **int** |  | 
+**failed_actions** | **List[str]** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.import_results import ImportResults
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ImportResults from a JSON string
+import_results_instance = ImportResults.from_json(json)
+# print the JSON string representation of the object
+print(ImportResults.to_json())
+
+# convert the object into a dict
+import_results_dict = import_results_instance.to_dict()
+# create an instance of ImportResults from a dict
+import_results_from_dict = ImportResults.from_dict(import_results_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/OAuthUrlResponse.md

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

@@ -0,0 +1,29 @@
+# OAuthUrlResponseData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **str** | The OAuth authorization URL | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.o_auth_url_response_data import OAuthUrlResponseData
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of OAuthUrlResponseData from a JSON string
+o_auth_url_response_data_instance = OAuthUrlResponseData.from_json(json)
+# print the JSON string representation of the object
+print(OAuthUrlResponseData.to_json())
+
+# convert the object into a dict
+o_auth_url_response_data_dict = o_auth_url_response_data_instance.to_dict()
+# create an instance of OAuthUrlResponseData from a dict
+o_auth_url_response_data_from_dict = OAuthUrlResponseData.from_dict(o_auth_url_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/OpenApiSpec.md

@@ -0,0 +1,30 @@
+# OpenApiSpec
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **str** | The OpenAPI spec as a JSON or YAML string | 
+**format** | **str** | Format of the OpenAPI spec | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.open_api_spec import OpenApiSpec
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of OpenApiSpec from a JSON string
+open_api_spec_instance = OpenApiSpec.from_json(json)
+# print the JSON string representation of the object
+print(OpenApiSpec.to_json())
+
+# convert the object into a dict
+open_api_spec_dict = open_api_spec_instance.to_dict()
+# create an instance of OpenApiSpec from a dict
+open_api_spec_from_dict = OpenApiSpec.from_dict(open_api_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)
+
+

workato_platform_cli/client/workato_api/docs/PackageDetailsResponse.md

@@ -0,0 +1,35 @@
+# PackageDetailsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**operation_type** | **str** |  | 
+**status** | **str** |  | 
+**export_manifest_id** | **int** |  | [optional] 
+**download_url** | **str** |  | [optional] 
+**error** | **str** | Error message when status is failed | [optional] 
+**recipe_status** | [**List[PackageDetailsResponseRecipeStatusInner]**](PackageDetailsResponseRecipeStatusInner.md) |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.package_details_response import PackageDetailsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PackageDetailsResponse from a JSON string
+package_details_response_instance = PackageDetailsResponse.from_json(json)
+# print the JSON string representation of the object
+print(PackageDetailsResponse.to_json())
+
+# convert the object into a dict
+package_details_response_dict = package_details_response_instance.to_dict()
+# create an instance of PackageDetailsResponse from a dict
+package_details_response_from_dict = PackageDetailsResponse.from_dict(package_details_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/PackageDetailsResponseRecipeStatusInner.md

@@ -0,0 +1,30 @@
+# PackageDetailsResponseRecipeStatusInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] 
+**import_result** | **str** |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.package_details_response_recipe_status_inner import PackageDetailsResponseRecipeStatusInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PackageDetailsResponseRecipeStatusInner from a JSON string
+package_details_response_recipe_status_inner_instance = PackageDetailsResponseRecipeStatusInner.from_json(json)
+# print the JSON string representation of the object
+print(PackageDetailsResponseRecipeStatusInner.to_json())
+
+# convert the object into a dict
+package_details_response_recipe_status_inner_dict = package_details_response_recipe_status_inner_instance.to_dict()
+# create an instance of PackageDetailsResponseRecipeStatusInner from a dict
+package_details_response_recipe_status_inner_from_dict = PackageDetailsResponseRecipeStatusInner.from_dict(package_details_response_recipe_status_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/PackageResponse.md

@@ -0,0 +1,33 @@
+# PackageResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**operation_type** | **str** |  | 
+**status** | **str** |  | 
+**export_manifest_id** | **int** |  | [optional] 
+**download_url** | **str** |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.package_response import PackageResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PackageResponse from a JSON string
+package_response_instance = PackageResponse.from_json(json)
+# print the JSON string representation of the object
+print(PackageResponse.to_json())
+
+# convert the object into a dict
+package_response_dict = package_response_instance.to_dict()
+# create an instance of PackageResponse from a dict
+package_response_from_dict = PackageResponse.from_dict(package_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)
+
+