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

workato_platform_cli/client/workato_api/docs/DataTablesApi.md

@@ -0,0 +1,172 @@
+# workato_platform_cli.client.workato_api.DataTablesApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_data_table**](DataTablesApi.md#create_data_table) | **POST** /api/data_tables | Create data table
+[**list_data_tables**](DataTablesApi.md#list_data_tables) | **GET** /api/data_tables | List data tables
+
+
+# **create_data_table**
+> DataTableCreateResponse create_data_table(data_table_create_request)
+
+Create data table
+
+Creates a data table in a folder you specify
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.data_table_create_request import DataTableCreateRequest
+from workato_platform_cli.client.workato_api.models.data_table_create_response import DataTableCreateResponse
+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.DataTablesApi(api_client)
+    data_table_create_request = workato_platform_cli.client.workato_api.DataTableCreateRequest() # DataTableCreateRequest | 
+
+    try:
+        # Create data table
+        api_response = await api_instance.create_data_table(data_table_create_request)
+        print("The response of DataTablesApi->create_data_table:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DataTablesApi->create_data_table: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data_table_create_request** | [**DataTableCreateRequest**](DataTableCreateRequest.md)|  | 
+
+### Return type
+
+[**DataTableCreateResponse**](DataTableCreateResponse.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** | Data table 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_data_tables**
+> DataTableListResponse list_data_tables(page=page, per_page=per_page)
+
+List data tables
+
+Returns a list of all data tables in your workspace
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.data_table_list_response import DataTableListResponse
+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.DataTablesApi(api_client)
+    page = 1 # int | Page number of the data tables to fetch (optional) (default to 1)
+    per_page = 100 # int | Page size (max 100) (optional) (default to 100)
+
+    try:
+        # List data tables
+        api_response = await api_instance.list_data_tables(page=page, per_page=per_page)
+        print("The response of DataTablesApi->list_data_tables:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DataTablesApi->list_data_tables: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **int**| Page number of the data tables to fetch | [optional] [default to 1]
+ **per_page** | **int**| Page size (max 100) | [optional] [default to 100]
+
+### Return type
+
+[**DataTableListResponse**](DataTableListResponse.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** | Data tables 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/DeleteProject403Response.md

@@ -0,0 +1,29 @@
+# DeleteProject403Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** |  | [optional] 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.delete_project403_response import DeleteProject403Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of DeleteProject403Response from a JSON string
+delete_project403_response_instance = DeleteProject403Response.from_json(json)
+# print the JSON string representation of the object
+print(DeleteProject403Response.to_json())
+
+# convert the object into a dict
+delete_project403_response_dict = delete_project403_response_instance.to_dict()
+# create an instance of DeleteProject403Response from a dict
+delete_project403_response_from_dict = DeleteProject403Response.from_dict(delete_project403_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/Error.md

@@ -0,0 +1,29 @@
+# Error
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.error import Error
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Error from a JSON string
+error_instance = Error.from_json(json)
+# print the JSON string representation of the object
+print(Error.to_json())
+
+# convert the object into a dict
+error_dict = error_instance.to_dict()
+# create an instance of Error from a dict
+error_from_dict = Error.from_dict(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)
+
+

workato_platform_cli/client/workato_api/docs/ExportApi.md

@@ -0,0 +1,175 @@
+# workato_platform_cli.client.workato_api.ExportApi
+
+All URIs are relative to *https://www.workato.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_export_manifest**](ExportApi.md#create_export_manifest) | **POST** /api/export_manifests | Create an export manifest
+[**list_assets_in_folder**](ExportApi.md#list_assets_in_folder) | **GET** /api/export_manifests/folder_assets | View assets in a folder
+
+
+# **create_export_manifest**
+> ExportManifestResponse create_export_manifest(create_export_manifest_request)
+
+Create an export manifest
+
+Create an export manifest for exporting assets
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.create_export_manifest_request import CreateExportManifestRequest
+from workato_platform_cli.client.workato_api.models.export_manifest_response import ExportManifestResponse
+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.ExportApi(api_client)
+    create_export_manifest_request = workato_platform_cli.client.workato_api.CreateExportManifestRequest() # CreateExportManifestRequest | 
+
+    try:
+        # Create an export manifest
+        api_response = await api_instance.create_export_manifest(create_export_manifest_request)
+        print("The response of ExportApi->create_export_manifest:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ExportApi->create_export_manifest: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_export_manifest_request** | [**CreateExportManifestRequest**](CreateExportManifestRequest.md)|  | 
+
+### Return type
+
+[**ExportManifestResponse**](ExportManifestResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Export manifest 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_assets_in_folder**
+> FolderAssetsResponse list_assets_in_folder(folder_id=folder_id, include_test_cases=include_test_cases, include_data=include_data)
+
+View assets in a folder
+
+View assets in a folder. Useful for creating or updating export manifests.
+
+
+### Example
+
+* Bearer Authentication (BearerAuth):
+
+```python
+import workato_platform_cli.client.workato_api
+from workato_platform_cli.client.workato_api.models.folder_assets_response import FolderAssetsResponse
+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.ExportApi(api_client)
+    folder_id = 56 # int | The ID of the folder containing the assets (optional)
+    include_test_cases = False # bool | Include test cases (currently not supported) (optional) (default to False)
+    include_data = False # bool | Include data from the list of assets (optional) (default to False)
+
+    try:
+        # View assets in a folder
+        api_response = await api_instance.list_assets_in_folder(folder_id=folder_id, include_test_cases=include_test_cases, include_data=include_data)
+        print("The response of ExportApi->list_assets_in_folder:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ExportApi->list_assets_in_folder: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **int**| The ID of the folder containing the assets | [optional] 
+ **include_test_cases** | **bool**| Include test cases (currently not supported) | [optional] [default to False]
+ **include_data** | **bool**| Include data from the list of assets | [optional] [default to False]
+
+### Return type
+
+[**FolderAssetsResponse**](FolderAssetsResponse.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** | Folder assets 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/ExportManifestRequest.md

@@ -0,0 +1,35 @@
+# ExportManifestRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the new manifest | 
+**assets** | [**List[AssetReference]**](AssetReference.md) | Dependent assets to include in the manifest | [optional] 
+**folder_id** | **int** | The ID of the folder containing the assets | [optional] 
+**include_test_cases** | **bool** | Whether the manifest includes test cases | [optional] [default to False]
+**auto_generate_assets** | **bool** | Auto-generates assets from a folder | [optional] [default to False]
+**include_data** | **bool** | Include data from automatic asset generation | [optional] [default to False]
+**include_tags** | **bool** | Include tags assigned to assets in the export manifest | [optional] [default to False]
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.export_manifest_request import ExportManifestRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExportManifestRequest from a JSON string
+export_manifest_request_instance = ExportManifestRequest.from_json(json)
+# print the JSON string representation of the object
+print(ExportManifestRequest.to_json())
+
+# convert the object into a dict
+export_manifest_request_dict = export_manifest_request_instance.to_dict()
+# create an instance of ExportManifestRequest from a dict
+export_manifest_request_from_dict = ExportManifestRequest.from_dict(export_manifest_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/ExportManifestResponse.md

@@ -0,0 +1,29 @@
+# ExportManifestResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | [**ExportManifestResponseResult**](ExportManifestResponseResult.md) |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.export_manifest_response import ExportManifestResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExportManifestResponse from a JSON string
+export_manifest_response_instance = ExportManifestResponse.from_json(json)
+# print the JSON string representation of the object
+print(ExportManifestResponse.to_json())
+
+# convert the object into a dict
+export_manifest_response_dict = export_manifest_response_instance.to_dict()
+# create an instance of ExportManifestResponse from a dict
+export_manifest_response_from_dict = ExportManifestResponse.from_dict(export_manifest_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/ExportManifestResponseResult.md

@@ -0,0 +1,36 @@
+# ExportManifestResponseResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**name** | **str** |  | 
+**last_exported_at** | **datetime** |  | 
+**created_at** | **datetime** |  | 
+**updated_at** | **datetime** |  | 
+**deleted_at** | **datetime** |  | 
+**project_path** | **str** |  | 
+**status** | **str** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.export_manifest_response_result import ExportManifestResponseResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ExportManifestResponseResult from a JSON string
+export_manifest_response_result_instance = ExportManifestResponseResult.from_json(json)
+# print the JSON string representation of the object
+print(ExportManifestResponseResult.to_json())
+
+# convert the object into a dict
+export_manifest_response_result_dict = export_manifest_response_result_instance.to_dict()
+# create an instance of ExportManifestResponseResult from a dict
+export_manifest_response_result_from_dict = ExportManifestResponseResult.from_dict(export_manifest_response_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)
+
+

workato_platform_cli/client/workato_api/docs/Folder.md

@@ -0,0 +1,35 @@
+# Folder
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**name** | **str** |  | 
+**parent_id** | **int** |  | 
+**is_project** | **bool** |  | 
+**project_id** | **int** |  | 
+**created_at** | **datetime** |  | 
+**updated_at** | **datetime** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.folder import Folder
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Folder from a JSON string
+folder_instance = Folder.from_json(json)
+# print the JSON string representation of the object
+print(Folder.to_json())
+
+# convert the object into a dict
+folder_dict = folder_instance.to_dict()
+# create an instance of Folder from a dict
+folder_from_dict = Folder.from_dict(folder_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/FolderAssetsResponse.md

@@ -0,0 +1,29 @@
+# FolderAssetsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | [**FolderAssetsResponseResult**](FolderAssetsResponseResult.md) |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.folder_assets_response import FolderAssetsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FolderAssetsResponse from a JSON string
+folder_assets_response_instance = FolderAssetsResponse.from_json(json)
+# print the JSON string representation of the object
+print(FolderAssetsResponse.to_json())
+
+# convert the object into a dict
+folder_assets_response_dict = folder_assets_response_instance.to_dict()
+# create an instance of FolderAssetsResponse from a dict
+folder_assets_response_from_dict = FolderAssetsResponse.from_dict(folder_assets_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/FolderAssetsResponseResult.md

@@ -0,0 +1,29 @@
+# FolderAssetsResponseResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assets** | [**List[Asset]**](Asset.md) |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.folder_assets_response_result import FolderAssetsResponseResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FolderAssetsResponseResult from a JSON string
+folder_assets_response_result_instance = FolderAssetsResponseResult.from_json(json)
+# print the JSON string representation of the object
+print(FolderAssetsResponseResult.to_json())
+
+# convert the object into a dict
+folder_assets_response_result_dict = folder_assets_response_result_instance.to_dict()
+# create an instance of FolderAssetsResponseResult from a dict
+folder_assets_response_result_from_dict = FolderAssetsResponseResult.from_dict(folder_assets_response_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)
+
+

workato_platform_cli/client/workato_api/docs/FolderCreationResponse.md

@@ -0,0 +1,35 @@
+# FolderCreationResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | 
+**name** | **str** |  | 
+**parent_id** | **int** |  | 
+**created_at** | **datetime** |  | 
+**updated_at** | **datetime** |  | 
+**project_id** | **int** |  | 
+**is_project** | **bool** |  | 
+
+## Example
+
+```python
+from workato_platform_cli.client.workato_api.models.folder_creation_response import FolderCreationResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FolderCreationResponse from a JSON string
+folder_creation_response_instance = FolderCreationResponse.from_json(json)
+# print the JSON string representation of the object
+print(FolderCreationResponse.to_json())
+
+# convert the object into a dict
+folder_creation_response_dict = folder_creation_response_instance.to_dict()
+# create an instance of FolderCreationResponse from a dict
+folder_creation_response_from_dict = FolderCreationResponse.from_dict(folder_creation_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)
+
+