workato-platform-cli 1.0.0rc5.dev5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- workato_platform_cli/__init__.py +135 -0
- workato_platform_cli/_version.py +34 -0
- workato_platform_cli/cli/__init__.py +126 -0
- workato_platform_cli/cli/commands/__init__.py +0 -0
- workato_platform_cli/cli/commands/api_clients.py +627 -0
- workato_platform_cli/cli/commands/api_collections.py +497 -0
- workato_platform_cli/cli/commands/assets.py +82 -0
- workato_platform_cli/cli/commands/connections.py +1205 -0
- workato_platform_cli/cli/commands/connectors/__init__.py +0 -0
- workato_platform_cli/cli/commands/connectors/command.py +178 -0
- workato_platform_cli/cli/commands/connectors/connector_manager.py +351 -0
- workato_platform_cli/cli/commands/data_tables.py +345 -0
- workato_platform_cli/cli/commands/guide.py +315 -0
- workato_platform_cli/cli/commands/init.py +229 -0
- workato_platform_cli/cli/commands/profiles.py +364 -0
- workato_platform_cli/cli/commands/projects/__init__.py +0 -0
- workato_platform_cli/cli/commands/projects/command.py +513 -0
- workato_platform_cli/cli/commands/projects/project_manager.py +338 -0
- workato_platform_cli/cli/commands/properties.py +174 -0
- workato_platform_cli/cli/commands/pull.py +327 -0
- workato_platform_cli/cli/commands/push/__init__.py +0 -0
- workato_platform_cli/cli/commands/push/command.py +320 -0
- workato_platform_cli/cli/commands/recipes/__init__.py +0 -0
- workato_platform_cli/cli/commands/recipes/command.py +847 -0
- workato_platform_cli/cli/commands/recipes/validator.py +1740 -0
- workato_platform_cli/cli/commands/workspace.py +73 -0
- workato_platform_cli/cli/containers.py +80 -0
- workato_platform_cli/cli/resources/data/connection-data.json +7364 -0
- workato_platform_cli/cli/resources/data/picklist-data.json +3706 -0
- workato_platform_cli/cli/resources/docs/README.md +178 -0
- workato_platform_cli/cli/resources/docs/actions.md +452 -0
- workato_platform_cli/cli/resources/docs/block-structure.md +424 -0
- workato_platform_cli/cli/resources/docs/connections-parameters.md +11946 -0
- workato_platform_cli/cli/resources/docs/data-mapping.md +779 -0
- workato_platform_cli/cli/resources/docs/formulas/array-list-formulas.md +1276 -0
- workato_platform_cli/cli/resources/docs/formulas/conditions.md +102 -0
- workato_platform_cli/cli/resources/docs/formulas/date-formulas.md +798 -0
- workato_platform_cli/cli/resources/docs/formulas/number-formulas.md +507 -0
- workato_platform_cli/cli/resources/docs/formulas/other-formulas.md +419 -0
- workato_platform_cli/cli/resources/docs/formulas/string-formulas.md +1353 -0
- workato_platform_cli/cli/resources/docs/formulas.md +214 -0
- workato_platform_cli/cli/resources/docs/naming-conventions.md +163 -0
- workato_platform_cli/cli/resources/docs/recipe-deployment-workflow.md +352 -0
- workato_platform_cli/cli/resources/docs/recipe-fundamentals.md +179 -0
- workato_platform_cli/cli/resources/docs/triggers.md +360 -0
- workato_platform_cli/cli/utils/__init__.py +10 -0
- workato_platform_cli/cli/utils/config/__init__.py +33 -0
- workato_platform_cli/cli/utils/config/manager.py +1001 -0
- workato_platform_cli/cli/utils/config/models.py +89 -0
- workato_platform_cli/cli/utils/config/profiles.py +491 -0
- workato_platform_cli/cli/utils/config/workspace.py +113 -0
- workato_platform_cli/cli/utils/exception_handler.py +531 -0
- workato_platform_cli/cli/utils/gitignore.py +32 -0
- workato_platform_cli/cli/utils/ignore_patterns.py +44 -0
- workato_platform_cli/cli/utils/spinner.py +63 -0
- workato_platform_cli/cli/utils/version_checker.py +237 -0
- workato_platform_cli/client/__init__.py +0 -0
- workato_platform_cli/client/workato_api/__init__.py +202 -0
- workato_platform_cli/client/workato_api/api/__init__.py +15 -0
- workato_platform_cli/client/workato_api/api/api_platform_api.py +2875 -0
- workato_platform_cli/client/workato_api/api/connections_api.py +1807 -0
- workato_platform_cli/client/workato_api/api/connectors_api.py +840 -0
- workato_platform_cli/client/workato_api/api/data_tables_api.py +604 -0
- workato_platform_cli/client/workato_api/api/export_api.py +621 -0
- workato_platform_cli/client/workato_api/api/folders_api.py +621 -0
- workato_platform_cli/client/workato_api/api/packages_api.py +1197 -0
- workato_platform_cli/client/workato_api/api/projects_api.py +590 -0
- workato_platform_cli/client/workato_api/api/properties_api.py +620 -0
- workato_platform_cli/client/workato_api/api/recipes_api.py +1379 -0
- workato_platform_cli/client/workato_api/api/users_api.py +285 -0
- workato_platform_cli/client/workato_api/api_client.py +807 -0
- workato_platform_cli/client/workato_api/api_response.py +21 -0
- workato_platform_cli/client/workato_api/configuration.py +601 -0
- workato_platform_cli/client/workato_api/docs/APIPlatformApi.md +844 -0
- workato_platform_cli/client/workato_api/docs/ApiClient.md +46 -0
- workato_platform_cli/client/workato_api/docs/ApiClientApiCollectionsInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/ApiClientApiPoliciesInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/ApiClientCreateRequest.md +46 -0
- workato_platform_cli/client/workato_api/docs/ApiClientListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiClientResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/ApiCollection.md +38 -0
- workato_platform_cli/client/workato_api/docs/ApiCollectionCreateRequest.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiEndpoint.md +41 -0
- workato_platform_cli/client/workato_api/docs/ApiKey.md +36 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyCreateRequest.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/Asset.md +39 -0
- workato_platform_cli/client/workato_api/docs/AssetReference.md +37 -0
- workato_platform_cli/client/workato_api/docs/Connection.md +44 -0
- workato_platform_cli/client/workato_api/docs/ConnectionCreateRequest.md +35 -0
- workato_platform_cli/client/workato_api/docs/ConnectionUpdateRequest.md +34 -0
- workato_platform_cli/client/workato_api/docs/ConnectionsApi.md +526 -0
- workato_platform_cli/client/workato_api/docs/ConnectorAction.md +33 -0
- workato_platform_cli/client/workato_api/docs/ConnectorVersion.md +32 -0
- workato_platform_cli/client/workato_api/docs/ConnectorsApi.md +249 -0
- workato_platform_cli/client/workato_api/docs/CreateExportManifestRequest.md +29 -0
- workato_platform_cli/client/workato_api/docs/CreateFolderRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/CustomConnector.md +35 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponseData.md +29 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTable.md +34 -0
- workato_platform_cli/client/workato_api/docs/DataTableColumn.md +37 -0
- workato_platform_cli/client/workato_api/docs/DataTableColumnRequest.md +37 -0
- workato_platform_cli/client/workato_api/docs/DataTableCreateRequest.md +31 -0
- workato_platform_cli/client/workato_api/docs/DataTableCreateResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTableListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTableRelation.md +30 -0
- workato_platform_cli/client/workato_api/docs/DataTablesApi.md +172 -0
- workato_platform_cli/client/workato_api/docs/DeleteProject403Response.md +29 -0
- workato_platform_cli/client/workato_api/docs/Error.md +29 -0
- workato_platform_cli/client/workato_api/docs/ExportApi.md +175 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestRequest.md +35 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestResponseResult.md +36 -0
- workato_platform_cli/client/workato_api/docs/Folder.md +35 -0
- workato_platform_cli/client/workato_api/docs/FolderAssetsResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/FolderAssetsResponseResult.md +29 -0
- workato_platform_cli/client/workato_api/docs/FolderCreationResponse.md +35 -0
- workato_platform_cli/client/workato_api/docs/FoldersApi.md +176 -0
- workato_platform_cli/client/workato_api/docs/ImportResults.md +32 -0
- workato_platform_cli/client/workato_api/docs/OAuthUrlResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/OAuthUrlResponseData.md +29 -0
- workato_platform_cli/client/workato_api/docs/OpenApiSpec.md +30 -0
- workato_platform_cli/client/workato_api/docs/PackageDetailsResponse.md +35 -0
- workato_platform_cli/client/workato_api/docs/PackageDetailsResponseRecipeStatusInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/PackageResponse.md +33 -0
- workato_platform_cli/client/workato_api/docs/PackagesApi.md +364 -0
- workato_platform_cli/client/workato_api/docs/PicklistRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/PicklistResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/PlatformConnector.md +36 -0
- workato_platform_cli/client/workato_api/docs/PlatformConnectorListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/Project.md +32 -0
- workato_platform_cli/client/workato_api/docs/ProjectsApi.md +173 -0
- workato_platform_cli/client/workato_api/docs/PropertiesApi.md +186 -0
- workato_platform_cli/client/workato_api/docs/Recipe.md +58 -0
- workato_platform_cli/client/workato_api/docs/RecipeConfigInner.md +33 -0
- workato_platform_cli/client/workato_api/docs/RecipeConnectionUpdateRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/RecipeListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/RecipeStartResponse.md +31 -0
- workato_platform_cli/client/workato_api/docs/RecipesApi.md +367 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionCreateRequest.md +34 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponseData.md +30 -0
- workato_platform_cli/client/workato_api/docs/SuccessResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/UpsertProjectPropertiesRequest.md +29 -0
- workato_platform_cli/client/workato_api/docs/User.md +48 -0
- workato_platform_cli/client/workato_api/docs/UsersApi.md +84 -0
- workato_platform_cli/client/workato_api/docs/ValidationError.md +30 -0
- workato_platform_cli/client/workato_api/docs/ValidationErrorErrorsValue.md +28 -0
- workato_platform_cli/client/workato_api/exceptions.py +216 -0
- workato_platform_cli/client/workato_api/models/__init__.py +83 -0
- workato_platform_cli/client/workato_api/models/api_client.py +185 -0
- workato_platform_cli/client/workato_api/models/api_client_api_collections_inner.py +89 -0
- workato_platform_cli/client/workato_api/models/api_client_api_policies_inner.py +89 -0
- workato_platform_cli/client/workato_api/models/api_client_create_request.py +138 -0
- workato_platform_cli/client/workato_api/models/api_client_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/api_client_response.py +91 -0
- workato_platform_cli/client/workato_api/models/api_collection.py +110 -0
- workato_platform_cli/client/workato_api/models/api_collection_create_request.py +97 -0
- workato_platform_cli/client/workato_api/models/api_endpoint.py +117 -0
- workato_platform_cli/client/workato_api/models/api_key.py +102 -0
- workato_platform_cli/client/workato_api/models/api_key_create_request.py +93 -0
- workato_platform_cli/client/workato_api/models/api_key_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/api_key_response.py +91 -0
- workato_platform_cli/client/workato_api/models/asset.py +124 -0
- workato_platform_cli/client/workato_api/models/asset_reference.py +110 -0
- workato_platform_cli/client/workato_api/models/connection.py +173 -0
- workato_platform_cli/client/workato_api/models/connection_create_request.py +99 -0
- workato_platform_cli/client/workato_api/models/connection_update_request.py +97 -0
- workato_platform_cli/client/workato_api/models/connector_action.py +100 -0
- workato_platform_cli/client/workato_api/models/connector_version.py +99 -0
- workato_platform_cli/client/workato_api/models/create_export_manifest_request.py +91 -0
- workato_platform_cli/client/workato_api/models/create_folder_request.py +89 -0
- workato_platform_cli/client/workato_api/models/custom_connector.py +117 -0
- workato_platform_cli/client/workato_api/models/custom_connector_code_response.py +91 -0
- workato_platform_cli/client/workato_api/models/custom_connector_code_response_data.py +87 -0
- workato_platform_cli/client/workato_api/models/custom_connector_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/data_table.py +107 -0
- workato_platform_cli/client/workato_api/models/data_table_column.py +125 -0
- workato_platform_cli/client/workato_api/models/data_table_column_request.py +130 -0
- workato_platform_cli/client/workato_api/models/data_table_create_request.py +99 -0
- workato_platform_cli/client/workato_api/models/data_table_create_response.py +91 -0
- workato_platform_cli/client/workato_api/models/data_table_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/data_table_relation.py +90 -0
- workato_platform_cli/client/workato_api/models/delete_project403_response.py +87 -0
- workato_platform_cli/client/workato_api/models/error.py +87 -0
- workato_platform_cli/client/workato_api/models/export_manifest_request.py +107 -0
- workato_platform_cli/client/workato_api/models/export_manifest_response.py +91 -0
- workato_platform_cli/client/workato_api/models/export_manifest_response_result.py +112 -0
- workato_platform_cli/client/workato_api/models/folder.py +110 -0
- workato_platform_cli/client/workato_api/models/folder_assets_response.py +91 -0
- workato_platform_cli/client/workato_api/models/folder_assets_response_result.py +95 -0
- workato_platform_cli/client/workato_api/models/folder_creation_response.py +110 -0
- workato_platform_cli/client/workato_api/models/import_results.py +93 -0
- workato_platform_cli/client/workato_api/models/o_auth_url_response.py +91 -0
- workato_platform_cli/client/workato_api/models/o_auth_url_response_data.py +87 -0
- workato_platform_cli/client/workato_api/models/open_api_spec.py +96 -0
- workato_platform_cli/client/workato_api/models/package_details_response.py +126 -0
- workato_platform_cli/client/workato_api/models/package_details_response_recipe_status_inner.py +99 -0
- workato_platform_cli/client/workato_api/models/package_response.py +109 -0
- workato_platform_cli/client/workato_api/models/picklist_request.py +89 -0
- workato_platform_cli/client/workato_api/models/picklist_response.py +88 -0
- workato_platform_cli/client/workato_api/models/platform_connector.py +116 -0
- workato_platform_cli/client/workato_api/models/platform_connector_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/project.py +93 -0
- workato_platform_cli/client/workato_api/models/recipe.py +174 -0
- workato_platform_cli/client/workato_api/models/recipe_config_inner.py +100 -0
- workato_platform_cli/client/workato_api/models/recipe_connection_update_request.py +89 -0
- workato_platform_cli/client/workato_api/models/recipe_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/recipe_start_response.py +91 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_create_request.py +97 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_response.py +91 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_response_data.py +89 -0
- workato_platform_cli/client/workato_api/models/success_response.py +87 -0
- workato_platform_cli/client/workato_api/models/upsert_project_properties_request.py +88 -0
- workato_platform_cli/client/workato_api/models/user.py +151 -0
- workato_platform_cli/client/workato_api/models/validation_error.py +102 -0
- workato_platform_cli/client/workato_api/models/validation_error_errors_value.py +143 -0
- workato_platform_cli/client/workato_api/rest.py +213 -0
- workato_platform_cli/client/workato_api/test/__init__.py +0 -0
- workato_platform_cli/client/workato_api/test/test_api_client.py +94 -0
- workato_platform_cli/client/workato_api/test/test_api_client_api_collections_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_api_client_api_policies_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_api_client_create_request.py +75 -0
- workato_platform_cli/client/workato_api/test/test_api_client_list_response.py +114 -0
- workato_platform_cli/client/workato_api/test/test_api_client_response.py +104 -0
- workato_platform_cli/client/workato_api/test/test_api_collection.py +72 -0
- workato_platform_cli/client/workato_api/test/test_api_collection_create_request.py +57 -0
- workato_platform_cli/client/workato_api/test/test_api_endpoint.py +75 -0
- workato_platform_cli/client/workato_api/test/test_api_key.py +64 -0
- workato_platform_cli/client/workato_api/test/test_api_key_create_request.py +56 -0
- workato_platform_cli/client/workato_api/test/test_api_key_list_response.py +78 -0
- workato_platform_cli/client/workato_api/test/test_api_key_response.py +68 -0
- workato_platform_cli/client/workato_api/test/test_api_platform_api.py +101 -0
- workato_platform_cli/client/workato_api/test/test_asset.py +67 -0
- workato_platform_cli/client/workato_api/test/test_asset_reference.py +62 -0
- workato_platform_cli/client/workato_api/test/test_connection.py +81 -0
- workato_platform_cli/client/workato_api/test/test_connection_create_request.py +59 -0
- workato_platform_cli/client/workato_api/test/test_connection_update_request.py +56 -0
- workato_platform_cli/client/workato_api/test/test_connections_api.py +73 -0
- workato_platform_cli/client/workato_api/test/test_connector_action.py +59 -0
- workato_platform_cli/client/workato_api/test/test_connector_version.py +58 -0
- workato_platform_cli/client/workato_api/test/test_connectors_api.py +52 -0
- workato_platform_cli/client/workato_api/test/test_create_export_manifest_request.py +88 -0
- workato_platform_cli/client/workato_api/test/test_create_folder_request.py +53 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector.py +76 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_code_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_code_response_data.py +52 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_list_response.py +82 -0
- workato_platform_cli/client/workato_api/test/test_data_table.py +88 -0
- workato_platform_cli/client/workato_api/test/test_data_table_column.py +72 -0
- workato_platform_cli/client/workato_api/test/test_data_table_column_request.py +64 -0
- workato_platform_cli/client/workato_api/test/test_data_table_create_request.py +82 -0
- workato_platform_cli/client/workato_api/test/test_data_table_create_response.py +90 -0
- workato_platform_cli/client/workato_api/test/test_data_table_list_response.py +94 -0
- workato_platform_cli/client/workato_api/test/test_data_table_relation.py +54 -0
- workato_platform_cli/client/workato_api/test/test_data_tables_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_delete_project403_response.py +51 -0
- workato_platform_cli/client/workato_api/test/test_error.py +52 -0
- workato_platform_cli/client/workato_api/test/test_export_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_request.py +69 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_response.py +68 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_response_result.py +66 -0
- workato_platform_cli/client/workato_api/test/test_folder.py +64 -0
- workato_platform_cli/client/workato_api/test/test_folder_assets_response.py +80 -0
- workato_platform_cli/client/workato_api/test/test_folder_assets_response_result.py +78 -0
- workato_platform_cli/client/workato_api/test/test_folder_creation_response.py +64 -0
- workato_platform_cli/client/workato_api/test/test_folders_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_import_results.py +58 -0
- workato_platform_cli/client/workato_api/test/test_o_auth_url_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_o_auth_url_response_data.py +52 -0
- workato_platform_cli/client/workato_api/test/test_open_api_spec.py +54 -0
- workato_platform_cli/client/workato_api/test/test_package_details_response.py +64 -0
- workato_platform_cli/client/workato_api/test/test_package_details_response_recipe_status_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_package_response.py +58 -0
- workato_platform_cli/client/workato_api/test/test_packages_api.py +59 -0
- workato_platform_cli/client/workato_api/test/test_picklist_request.py +53 -0
- workato_platform_cli/client/workato_api/test/test_picklist_response.py +52 -0
- workato_platform_cli/client/workato_api/test/test_platform_connector.py +94 -0
- workato_platform_cli/client/workato_api/test/test_platform_connector_list_response.py +106 -0
- workato_platform_cli/client/workato_api/test/test_project.py +57 -0
- workato_platform_cli/client/workato_api/test/test_projects_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_properties_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_recipe.py +124 -0
- workato_platform_cli/client/workato_api/test/test_recipe_config_inner.py +55 -0
- workato_platform_cli/client/workato_api/test/test_recipe_connection_update_request.py +54 -0
- workato_platform_cli/client/workato_api/test/test_recipe_list_response.py +134 -0
- workato_platform_cli/client/workato_api/test/test_recipe_start_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_recipes_api.py +59 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_create_request.py +59 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_response.py +56 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_response_data.py +54 -0
- workato_platform_cli/client/workato_api/test/test_success_response.py +52 -0
- workato_platform_cli/client/workato_api/test/test_upsert_project_properties_request.py +52 -0
- workato_platform_cli/client/workato_api/test/test_user.py +85 -0
- workato_platform_cli/client/workato_api/test/test_users_api.py +38 -0
- workato_platform_cli/client/workato_api/test/test_validation_error.py +52 -0
- workato_platform_cli/client/workato_api/test/test_validation_error_errors_value.py +50 -0
- workato_platform_cli/client/workato_api_README.md +205 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/METADATA +185 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/RECORD +306 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/WHEEL +4 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/entry_points.txt +2 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/licenses/LICENSE +7 -0
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Workato Platform API
|
|
5
|
+
|
|
6
|
+
Official Workato Platform API for managing recipes, connections, projects, and other automation resources. ## Authentication All endpoints require a Bearer token in the Authorization header. ## Base URL The base URL varies by region: - US: `https://www.workato.com` - EU: `https://app.eu.workato.com` - JP: `https://app.jp.workato.com` - SG: `https://app.sg.workato.com` - AU: `https://app.au.workato.com` - IL: `https://app.il.workato.com` - Trial: `https://app.trial.workato.com`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
import unittest
|
|
16
|
+
|
|
17
|
+
from workato_platform_cli.client.workato_api.api.users_api import UsersApi
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
class TestUsersApi(unittest.IsolatedAsyncioTestCase):
|
|
21
|
+
"""UsersApi unit test stubs"""
|
|
22
|
+
|
|
23
|
+
async def asyncSetUp(self) -> None:
|
|
24
|
+
self.api = UsersApi()
|
|
25
|
+
|
|
26
|
+
async def asyncTearDown(self) -> None:
|
|
27
|
+
await self.api.api_client.close()
|
|
28
|
+
|
|
29
|
+
async def test_get_workspace_details(self) -> None:
|
|
30
|
+
"""Test case for get_workspace_details
|
|
31
|
+
|
|
32
|
+
Get current user information
|
|
33
|
+
"""
|
|
34
|
+
pass
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
if __name__ == '__main__':
|
|
38
|
+
unittest.main()
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Workato Platform API
|
|
5
|
+
|
|
6
|
+
Official Workato Platform API for managing recipes, connections, projects, and other automation resources. ## Authentication All endpoints require a Bearer token in the Authorization header. ## Base URL The base URL varies by region: - US: `https://www.workato.com` - EU: `https://app.eu.workato.com` - JP: `https://app.jp.workato.com` - SG: `https://app.sg.workato.com` - AU: `https://app.au.workato.com` - IL: `https://app.il.workato.com` - Trial: `https://app.trial.workato.com`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
import unittest
|
|
16
|
+
|
|
17
|
+
from workato_platform_cli.client.workato_api.models.validation_error import ValidationError
|
|
18
|
+
|
|
19
|
+
class TestValidationError(unittest.TestCase):
|
|
20
|
+
"""ValidationError unit test stubs"""
|
|
21
|
+
|
|
22
|
+
def setUp(self):
|
|
23
|
+
pass
|
|
24
|
+
|
|
25
|
+
def tearDown(self):
|
|
26
|
+
pass
|
|
27
|
+
|
|
28
|
+
def make_instance(self, include_optional) -> ValidationError:
|
|
29
|
+
"""Test ValidationError
|
|
30
|
+
include_optional is a boolean, when False only required
|
|
31
|
+
params are included, when True both required and
|
|
32
|
+
optional params are included """
|
|
33
|
+
# uncomment below to create an instance of `ValidationError`
|
|
34
|
+
"""
|
|
35
|
+
model = ValidationError()
|
|
36
|
+
if include_optional:
|
|
37
|
+
return ValidationError(
|
|
38
|
+
message = 'Validation failed',
|
|
39
|
+
errors = {"name":["can't be blank"],"provider":["is not included in the list"]}
|
|
40
|
+
)
|
|
41
|
+
else:
|
|
42
|
+
return ValidationError(
|
|
43
|
+
)
|
|
44
|
+
"""
|
|
45
|
+
|
|
46
|
+
def testValidationError(self):
|
|
47
|
+
"""Test ValidationError"""
|
|
48
|
+
# inst_req_only = self.make_instance(include_optional=False)
|
|
49
|
+
# inst_req_and_optional = self.make_instance(include_optional=True)
|
|
50
|
+
|
|
51
|
+
if __name__ == '__main__':
|
|
52
|
+
unittest.main()
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Workato Platform API
|
|
5
|
+
|
|
6
|
+
Official Workato Platform API for managing recipes, connections, projects, and other automation resources. ## Authentication All endpoints require a Bearer token in the Authorization header. ## Base URL The base URL varies by region: - US: `https://www.workato.com` - EU: `https://app.eu.workato.com` - JP: `https://app.jp.workato.com` - SG: `https://app.sg.workato.com` - AU: `https://app.au.workato.com` - IL: `https://app.il.workato.com` - Trial: `https://app.trial.workato.com`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
import unittest
|
|
16
|
+
|
|
17
|
+
from workato_platform_cli.client.workato_api.models.validation_error_errors_value import ValidationErrorErrorsValue
|
|
18
|
+
|
|
19
|
+
class TestValidationErrorErrorsValue(unittest.TestCase):
|
|
20
|
+
"""ValidationErrorErrorsValue unit test stubs"""
|
|
21
|
+
|
|
22
|
+
def setUp(self):
|
|
23
|
+
pass
|
|
24
|
+
|
|
25
|
+
def tearDown(self):
|
|
26
|
+
pass
|
|
27
|
+
|
|
28
|
+
def make_instance(self, include_optional) -> ValidationErrorErrorsValue:
|
|
29
|
+
"""Test ValidationErrorErrorsValue
|
|
30
|
+
include_optional is a boolean, when False only required
|
|
31
|
+
params are included, when True both required and
|
|
32
|
+
optional params are included """
|
|
33
|
+
# uncomment below to create an instance of `ValidationErrorErrorsValue`
|
|
34
|
+
"""
|
|
35
|
+
model = ValidationErrorErrorsValue()
|
|
36
|
+
if include_optional:
|
|
37
|
+
return ValidationErrorErrorsValue(
|
|
38
|
+
)
|
|
39
|
+
else:
|
|
40
|
+
return ValidationErrorErrorsValue(
|
|
41
|
+
)
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
def testValidationErrorErrorsValue(self):
|
|
45
|
+
"""Test ValidationErrorErrorsValue"""
|
|
46
|
+
# inst_req_only = self.make_instance(include_optional=False)
|
|
47
|
+
# inst_req_and_optional = self.make_instance(include_optional=True)
|
|
48
|
+
|
|
49
|
+
if __name__ == '__main__':
|
|
50
|
+
unittest.main()
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
# workato-platform-cli
|
|
2
|
+
Official Workato Platform API for managing recipes, connections, projects, and other automation resources. ## Authentication All endpoints require a Bearer token in the Authorization header. ## Base URL The base URL varies by region: - US: `https://www.workato.com` - EU: `https://app.eu.workato.com` - JP: `https://app.jp.workato.com` - SG: `https://app.sg.workato.com` - AU: `https://app.au.workato.com` - IL: `https://app.il.workato.com` - Trial: `https://app.trial.workato.com`
|
|
3
|
+
|
|
4
|
+
The `workato_platform_cli.client.workato_api` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 1.0.0
|
|
7
|
+
- Package version: 1.0.0
|
|
8
|
+
- Generator version: 7.16.0
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
For more information, please visit [https://docs.workato.com](https://docs.workato.com)
|
|
11
|
+
|
|
12
|
+
## Requirements.
|
|
13
|
+
|
|
14
|
+
Python 3.9+
|
|
15
|
+
|
|
16
|
+
## Installation & Usage
|
|
17
|
+
|
|
18
|
+
This python library package is generated without supporting files like setup.py or requirements files
|
|
19
|
+
|
|
20
|
+
To be able to use it, you will need these dependencies in your own package that uses this library:
|
|
21
|
+
|
|
22
|
+
* urllib3 >= 2.1.0, < 3.0.0
|
|
23
|
+
* python-dateutil >= 2.8.2
|
|
24
|
+
* aiohttp >= 3.8.4
|
|
25
|
+
* aiohttp-retry >= 2.8.3
|
|
26
|
+
* pydantic >= 2
|
|
27
|
+
* typing-extensions >= 4.7.1
|
|
28
|
+
|
|
29
|
+
## Getting Started
|
|
30
|
+
|
|
31
|
+
In your own code, to use this library to connect and interact with workato-platform-cli,
|
|
32
|
+
you can run the following:
|
|
33
|
+
|
|
34
|
+
```python
|
|
35
|
+
|
|
36
|
+
import workato_platform_cli.client.workato_api
|
|
37
|
+
from workato_platform_cli.client.workato_api.rest import ApiException
|
|
38
|
+
from pprint import pprint
|
|
39
|
+
|
|
40
|
+
# Defining the host is optional and defaults to https://www.workato.com
|
|
41
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
42
|
+
configuration = workato_platform_cli.client.workato_api.Configuration(
|
|
43
|
+
host = "https://www.workato.com"
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
# The client must configure the authentication and authorization parameters
|
|
47
|
+
# in accordance with the API server security policy.
|
|
48
|
+
# Examples for each auth method are provided below, use the example that
|
|
49
|
+
# satisfies your auth use case.
|
|
50
|
+
|
|
51
|
+
# Configure Bearer authorization: BearerAuth
|
|
52
|
+
configuration = workato_platform_cli.client.workato_api.Configuration(
|
|
53
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Enter a context with an instance of the API client
|
|
58
|
+
async with workato_platform_cli.client.workato_api.ApiClient(configuration) as api_client:
|
|
59
|
+
# Create an instance of the API class
|
|
60
|
+
api_instance = workato_platform_cli.client.workato_api.APIPlatformApi(api_client)
|
|
61
|
+
api_client_create_request = workato_platform_cli.client.workato_api.ApiClientCreateRequest() # ApiClientCreateRequest |
|
|
62
|
+
|
|
63
|
+
try:
|
|
64
|
+
# Create API client (v2)
|
|
65
|
+
api_response = await api_instance.create_api_client(api_client_create_request)
|
|
66
|
+
print("The response of APIPlatformApi->create_api_client:\n")
|
|
67
|
+
pprint(api_response)
|
|
68
|
+
except ApiException as e:
|
|
69
|
+
print("Exception when calling APIPlatformApi->create_api_client: %s\n" % e)
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Documentation for API Endpoints
|
|
74
|
+
|
|
75
|
+
All URIs are relative to *https://www.workato.com*
|
|
76
|
+
|
|
77
|
+
Class | Method | HTTP request | Description
|
|
78
|
+
------------ | ------------- | ------------- | -------------
|
|
79
|
+
*APIPlatformApi* | [**create_api_client**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#create_api_client) | **POST** /api/v2/api_clients | Create API client (v2)
|
|
80
|
+
*APIPlatformApi* | [**create_api_collection**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#create_api_collection) | **POST** /api/api_collections | Create API collection
|
|
81
|
+
*APIPlatformApi* | [**create_api_key**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#create_api_key) | **POST** /api/v2/api_clients/{api_client_id}/api_keys | Create an API key
|
|
82
|
+
*APIPlatformApi* | [**disable_api_endpoint**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#disable_api_endpoint) | **PUT** /api/api_endpoints/{api_endpoint_id}/disable | Disable an API endpoint
|
|
83
|
+
*APIPlatformApi* | [**enable_api_endpoint**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#enable_api_endpoint) | **PUT** /api/api_endpoints/{api_endpoint_id}/enable | Enable an API endpoint
|
|
84
|
+
*APIPlatformApi* | [**list_api_clients**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#list_api_clients) | **GET** /api/v2/api_clients | List API clients (v2)
|
|
85
|
+
*APIPlatformApi* | [**list_api_collections**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#list_api_collections) | **GET** /api/api_collections | List API collections
|
|
86
|
+
*APIPlatformApi* | [**list_api_endpoints**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#list_api_endpoints) | **GET** /api/api_endpoints | List API endpoints
|
|
87
|
+
*APIPlatformApi* | [**list_api_keys**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#list_api_keys) | **GET** /api/v2/api_clients/{api_client_id}/api_keys | List API keys
|
|
88
|
+
*APIPlatformApi* | [**refresh_api_key_secret**](workato_platform_cli/client/workato_api/docs/APIPlatformApi.md#refresh_api_key_secret) | **PUT** /api/v2/api_clients/{api_client_id}/api_keys/{api_key_id}/refresh_secret | Refresh API key secret
|
|
89
|
+
*ConnectionsApi* | [**create_connection**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#create_connection) | **POST** /api/connections | Create a connection
|
|
90
|
+
*ConnectionsApi* | [**create_runtime_user_connection**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#create_runtime_user_connection) | **POST** /api/connections/runtime_user_connections | Create OAuth runtime user connection
|
|
91
|
+
*ConnectionsApi* | [**get_connection_oauth_url**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#get_connection_oauth_url) | **GET** /api/connections/runtime_user_connections/{connection_id}/get_oauth_url | Get OAuth URL for connection
|
|
92
|
+
*ConnectionsApi* | [**get_connection_picklist**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#get_connection_picklist) | **POST** /api/connections/{connection_id}/pick_list | Get picklist values
|
|
93
|
+
*ConnectionsApi* | [**list_connections**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#list_connections) | **GET** /api/connections | List connections
|
|
94
|
+
*ConnectionsApi* | [**update_connection**](workato_platform_cli/client/workato_api/docs/ConnectionsApi.md#update_connection) | **PUT** /api/connections/{connection_id} | Update a connection
|
|
95
|
+
*ConnectorsApi* | [**get_custom_connector_code**](workato_platform_cli/client/workato_api/docs/ConnectorsApi.md#get_custom_connector_code) | **GET** /api/custom_connectors/{id}/code | Get custom connector code
|
|
96
|
+
*ConnectorsApi* | [**list_custom_connectors**](workato_platform_cli/client/workato_api/docs/ConnectorsApi.md#list_custom_connectors) | **GET** /api/custom_connectors | List custom connectors
|
|
97
|
+
*ConnectorsApi* | [**list_platform_connectors**](workato_platform_cli/client/workato_api/docs/ConnectorsApi.md#list_platform_connectors) | **GET** /api/integrations/all | List platform connectors
|
|
98
|
+
*DataTablesApi* | [**create_data_table**](workato_platform_cli/client/workato_api/docs/DataTablesApi.md#create_data_table) | **POST** /api/data_tables | Create data table
|
|
99
|
+
*DataTablesApi* | [**list_data_tables**](workato_platform_cli/client/workato_api/docs/DataTablesApi.md#list_data_tables) | **GET** /api/data_tables | List data tables
|
|
100
|
+
*ExportApi* | [**create_export_manifest**](workato_platform_cli/client/workato_api/docs/ExportApi.md#create_export_manifest) | **POST** /api/export_manifests | Create an export manifest
|
|
101
|
+
*ExportApi* | [**list_assets_in_folder**](workato_platform_cli/client/workato_api/docs/ExportApi.md#list_assets_in_folder) | **GET** /api/export_manifests/folder_assets | View assets in a folder
|
|
102
|
+
*FoldersApi* | [**create_folder**](workato_platform_cli/client/workato_api/docs/FoldersApi.md#create_folder) | **POST** /api/folders | Create a folder
|
|
103
|
+
*FoldersApi* | [**list_folders**](workato_platform_cli/client/workato_api/docs/FoldersApi.md#list_folders) | **GET** /api/folders | List folders
|
|
104
|
+
*PackagesApi* | [**download_package**](workato_platform_cli/client/workato_api/docs/PackagesApi.md#download_package) | **GET** /api/packages/{package_id}/download | Download package
|
|
105
|
+
*PackagesApi* | [**export_package**](workato_platform_cli/client/workato_api/docs/PackagesApi.md#export_package) | **POST** /api/packages/export/{id} | Export a package based on a manifest
|
|
106
|
+
*PackagesApi* | [**get_package**](workato_platform_cli/client/workato_api/docs/PackagesApi.md#get_package) | **GET** /api/packages/{package_id} | Get package details
|
|
107
|
+
*PackagesApi* | [**import_package**](workato_platform_cli/client/workato_api/docs/PackagesApi.md#import_package) | **POST** /api/packages/import/{id} | Import a package into a folder
|
|
108
|
+
*ProjectsApi* | [**delete_project**](workato_platform_cli/client/workato_api/docs/ProjectsApi.md#delete_project) | **DELETE** /api/projects/{project_id} | Delete a project
|
|
109
|
+
*ProjectsApi* | [**list_projects**](workato_platform_cli/client/workato_api/docs/ProjectsApi.md#list_projects) | **GET** /api/projects | List projects
|
|
110
|
+
*PropertiesApi* | [**list_project_properties**](workato_platform_cli/client/workato_api/docs/PropertiesApi.md#list_project_properties) | **GET** /api/properties | List project properties
|
|
111
|
+
*PropertiesApi* | [**upsert_project_properties**](workato_platform_cli/client/workato_api/docs/PropertiesApi.md#upsert_project_properties) | **POST** /api/properties | Upsert project properties
|
|
112
|
+
*RecipesApi* | [**list_recipes**](workato_platform_cli/client/workato_api/docs/RecipesApi.md#list_recipes) | **GET** /api/recipes | List recipes
|
|
113
|
+
*RecipesApi* | [**start_recipe**](workato_platform_cli/client/workato_api/docs/RecipesApi.md#start_recipe) | **PUT** /api/recipes/{recipe_id}/start | Start a recipe
|
|
114
|
+
*RecipesApi* | [**stop_recipe**](workato_platform_cli/client/workato_api/docs/RecipesApi.md#stop_recipe) | **PUT** /api/recipes/{recipe_id}/stop | Stop a recipe
|
|
115
|
+
*RecipesApi* | [**update_recipe_connection**](workato_platform_cli/client/workato_api/docs/RecipesApi.md#update_recipe_connection) | **PUT** /api/recipes/{recipe_id}/connect | Update a connection for a recipe
|
|
116
|
+
*UsersApi* | [**get_workspace_details**](workato_platform_cli/client/workato_api/docs/UsersApi.md#get_workspace_details) | **GET** /api/users/me | Get current user information
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
## Documentation For Models
|
|
120
|
+
|
|
121
|
+
- [ApiClient](workato_platform_cli/client/workato_api/docs/ApiClient.md)
|
|
122
|
+
- [ApiClientApiCollectionsInner](workato_platform_cli/client/workato_api/docs/ApiClientApiCollectionsInner.md)
|
|
123
|
+
- [ApiClientApiPoliciesInner](workato_platform_cli/client/workato_api/docs/ApiClientApiPoliciesInner.md)
|
|
124
|
+
- [ApiClientCreateRequest](workato_platform_cli/client/workato_api/docs/ApiClientCreateRequest.md)
|
|
125
|
+
- [ApiClientListResponse](workato_platform_cli/client/workato_api/docs/ApiClientListResponse.md)
|
|
126
|
+
- [ApiClientResponse](workato_platform_cli/client/workato_api/docs/ApiClientResponse.md)
|
|
127
|
+
- [ApiCollection](workato_platform_cli/client/workato_api/docs/ApiCollection.md)
|
|
128
|
+
- [ApiCollectionCreateRequest](workato_platform_cli/client/workato_api/docs/ApiCollectionCreateRequest.md)
|
|
129
|
+
- [ApiEndpoint](workato_platform_cli/client/workato_api/docs/ApiEndpoint.md)
|
|
130
|
+
- [ApiKey](workato_platform_cli/client/workato_api/docs/ApiKey.md)
|
|
131
|
+
- [ApiKeyCreateRequest](workato_platform_cli/client/workato_api/docs/ApiKeyCreateRequest.md)
|
|
132
|
+
- [ApiKeyListResponse](workato_platform_cli/client/workato_api/docs/ApiKeyListResponse.md)
|
|
133
|
+
- [ApiKeyResponse](workato_platform_cli/client/workato_api/docs/ApiKeyResponse.md)
|
|
134
|
+
- [Asset](workato_platform_cli/client/workato_api/docs/Asset.md)
|
|
135
|
+
- [AssetReference](workato_platform_cli/client/workato_api/docs/AssetReference.md)
|
|
136
|
+
- [Connection](workato_platform_cli/client/workato_api/docs/Connection.md)
|
|
137
|
+
- [ConnectionCreateRequest](workato_platform_cli/client/workato_api/docs/ConnectionCreateRequest.md)
|
|
138
|
+
- [ConnectionUpdateRequest](workato_platform_cli/client/workato_api/docs/ConnectionUpdateRequest.md)
|
|
139
|
+
- [ConnectorAction](workato_platform_cli/client/workato_api/docs/ConnectorAction.md)
|
|
140
|
+
- [ConnectorVersion](workato_platform_cli/client/workato_api/docs/ConnectorVersion.md)
|
|
141
|
+
- [CreateExportManifestRequest](workato_platform_cli/client/workato_api/docs/CreateExportManifestRequest.md)
|
|
142
|
+
- [CreateFolderRequest](workato_platform_cli/client/workato_api/docs/CreateFolderRequest.md)
|
|
143
|
+
- [CustomConnector](workato_platform_cli/client/workato_api/docs/CustomConnector.md)
|
|
144
|
+
- [CustomConnectorCodeResponse](workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponse.md)
|
|
145
|
+
- [CustomConnectorCodeResponseData](workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponseData.md)
|
|
146
|
+
- [CustomConnectorListResponse](workato_platform_cli/client/workato_api/docs/CustomConnectorListResponse.md)
|
|
147
|
+
- [DataTable](workato_platform_cli/client/workato_api/docs/DataTable.md)
|
|
148
|
+
- [DataTableColumn](workato_platform_cli/client/workato_api/docs/DataTableColumn.md)
|
|
149
|
+
- [DataTableColumnRequest](workato_platform_cli/client/workato_api/docs/DataTableColumnRequest.md)
|
|
150
|
+
- [DataTableCreateRequest](workato_platform_cli/client/workato_api/docs/DataTableCreateRequest.md)
|
|
151
|
+
- [DataTableCreateResponse](workato_platform_cli/client/workato_api/docs/DataTableCreateResponse.md)
|
|
152
|
+
- [DataTableListResponse](workato_platform_cli/client/workato_api/docs/DataTableListResponse.md)
|
|
153
|
+
- [DataTableRelation](workato_platform_cli/client/workato_api/docs/DataTableRelation.md)
|
|
154
|
+
- [DeleteProject403Response](workato_platform_cli/client/workato_api/docs/DeleteProject403Response.md)
|
|
155
|
+
- [Error](workato_platform_cli/client/workato_api/docs/Error.md)
|
|
156
|
+
- [ExportManifestRequest](workato_platform_cli/client/workato_api/docs/ExportManifestRequest.md)
|
|
157
|
+
- [ExportManifestResponse](workato_platform_cli/client/workato_api/docs/ExportManifestResponse.md)
|
|
158
|
+
- [ExportManifestResponseResult](workato_platform_cli/client/workato_api/docs/ExportManifestResponseResult.md)
|
|
159
|
+
- [Folder](workato_platform_cli/client/workato_api/docs/Folder.md)
|
|
160
|
+
- [FolderAssetsResponse](workato_platform_cli/client/workato_api/docs/FolderAssetsResponse.md)
|
|
161
|
+
- [FolderAssetsResponseResult](workato_platform_cli/client/workato_api/docs/FolderAssetsResponseResult.md)
|
|
162
|
+
- [FolderCreationResponse](workato_platform_cli/client/workato_api/docs/FolderCreationResponse.md)
|
|
163
|
+
- [ImportResults](workato_platform_cli/client/workato_api/docs/ImportResults.md)
|
|
164
|
+
- [OAuthUrlResponse](workato_platform_cli/client/workato_api/docs/OAuthUrlResponse.md)
|
|
165
|
+
- [OAuthUrlResponseData](workato_platform_cli/client/workato_api/docs/OAuthUrlResponseData.md)
|
|
166
|
+
- [OpenApiSpec](workato_platform_cli/client/workato_api/docs/OpenApiSpec.md)
|
|
167
|
+
- [PackageDetailsResponse](workato_platform_cli/client/workato_api/docs/PackageDetailsResponse.md)
|
|
168
|
+
- [PackageDetailsResponseRecipeStatusInner](workato_platform_cli/client/workato_api/docs/PackageDetailsResponseRecipeStatusInner.md)
|
|
169
|
+
- [PackageResponse](workato_platform_cli/client/workato_api/docs/PackageResponse.md)
|
|
170
|
+
- [PicklistRequest](workato_platform_cli/client/workato_api/docs/PicklistRequest.md)
|
|
171
|
+
- [PicklistResponse](workato_platform_cli/client/workato_api/docs/PicklistResponse.md)
|
|
172
|
+
- [PlatformConnector](workato_platform_cli/client/workato_api/docs/PlatformConnector.md)
|
|
173
|
+
- [PlatformConnectorListResponse](workato_platform_cli/client/workato_api/docs/PlatformConnectorListResponse.md)
|
|
174
|
+
- [Project](workato_platform_cli/client/workato_api/docs/Project.md)
|
|
175
|
+
- [Recipe](workato_platform_cli/client/workato_api/docs/Recipe.md)
|
|
176
|
+
- [RecipeConfigInner](workato_platform_cli/client/workato_api/docs/RecipeConfigInner.md)
|
|
177
|
+
- [RecipeConnectionUpdateRequest](workato_platform_cli/client/workato_api/docs/RecipeConnectionUpdateRequest.md)
|
|
178
|
+
- [RecipeListResponse](workato_platform_cli/client/workato_api/docs/RecipeListResponse.md)
|
|
179
|
+
- [RecipeStartResponse](workato_platform_cli/client/workato_api/docs/RecipeStartResponse.md)
|
|
180
|
+
- [RuntimeUserConnectionCreateRequest](workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionCreateRequest.md)
|
|
181
|
+
- [RuntimeUserConnectionResponse](workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponse.md)
|
|
182
|
+
- [RuntimeUserConnectionResponseData](workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponseData.md)
|
|
183
|
+
- [SuccessResponse](workato_platform_cli/client/workato_api/docs/SuccessResponse.md)
|
|
184
|
+
- [UpsertProjectPropertiesRequest](workato_platform_cli/client/workato_api/docs/UpsertProjectPropertiesRequest.md)
|
|
185
|
+
- [User](workato_platform_cli/client/workato_api/docs/User.md)
|
|
186
|
+
- [ValidationError](workato_platform_cli/client/workato_api/docs/ValidationError.md)
|
|
187
|
+
- [ValidationErrorErrorsValue](workato_platform_cli/client/workato_api/docs/ValidationErrorErrorsValue.md)
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<a id="documentation-for-authorization"></a>
|
|
191
|
+
## Documentation For Authorization
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
Authentication schemes defined for the API:
|
|
195
|
+
<a id="BearerAuth"></a>
|
|
196
|
+
### BearerAuth
|
|
197
|
+
|
|
198
|
+
- **Type**: Bearer authentication
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
## Author
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: workato-platform-cli
|
|
3
|
+
Version: 1.0.0rc5.dev5
|
|
4
|
+
Summary: CLI tool for the Workato Platform
|
|
5
|
+
Project-URL: Homepage, https://github.com/workato-devs/workato-platform-cli
|
|
6
|
+
Project-URL: Repository, https://github.com/workato-devs/workato-platform-cli.git
|
|
7
|
+
Project-URL: Issues, https://github.com/workato-devs/workato-platform-cli/issues
|
|
8
|
+
Author-email: Workato CLI Team <workato-devs@workato.com>
|
|
9
|
+
License: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: api,automation,cli,workato
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
22
|
+
Requires-Python: >=3.11
|
|
23
|
+
Requires-Dist: aiohttp-retry>=2.8.0
|
|
24
|
+
Requires-Dist: aiohttp>=3.8.0
|
|
25
|
+
Requires-Dist: asyncclick>=8.3.0
|
|
26
|
+
Requires-Dist: cbor2>=5.7.0
|
|
27
|
+
Requires-Dist: certifi>=2025.8.3
|
|
28
|
+
Requires-Dist: dependency-injector>=4.41.0
|
|
29
|
+
Requires-Dist: inquirer>=3.1.0
|
|
30
|
+
Requires-Dist: keyring>=25.6.0
|
|
31
|
+
Requires-Dist: packaging>=21.0
|
|
32
|
+
Requires-Dist: pydantic>=2.11.7
|
|
33
|
+
Requires-Dist: python-dateutil>=2.8.0
|
|
34
|
+
Requires-Dist: ruff==0.13.0
|
|
35
|
+
Requires-Dist: typing-extensions>=4.0.0
|
|
36
|
+
Requires-Dist: urllib3>=2.5.0
|
|
37
|
+
Provides-Extra: dev
|
|
38
|
+
Requires-Dist: coverage[toml]>=7.0.0; extra == 'dev'
|
|
39
|
+
Requires-Dist: mypy>=1.0.0; extra == 'dev'
|
|
40
|
+
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
|
|
41
|
+
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
|
|
42
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
|
|
43
|
+
Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
|
|
44
|
+
Requires-Dist: pytest>=7.0.0; extra == 'dev'
|
|
45
|
+
Requires-Dist: ruff>=0.1.0; extra == 'dev'
|
|
46
|
+
Provides-Extra: test
|
|
47
|
+
Requires-Dist: coverage>=7.0.0; extra == 'test'
|
|
48
|
+
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
|
|
49
|
+
Requires-Dist: pytest-mock>=3.10.0; extra == 'test'
|
|
50
|
+
Requires-Dist: pytest>=7.0.0; extra == 'test'
|
|
51
|
+
Description-Content-Type: text/markdown
|
|
52
|
+
|
|
53
|
+
# Workato Platform CLI
|
|
54
|
+
|
|
55
|
+
A modern, type-safe command-line interface for the Workato API, designed for automation and AI agent interaction. **Perfect for AI agents helping developers build, validate, and manage Workato recipes, connections, and projects.**
|
|
56
|
+
|
|
57
|
+
[](https://www.python.org/downloads/)
|
|
58
|
+
[](https://mypy.readthedocs.io/)
|
|
59
|
+
[](https://docs.astral.sh/ruff/)
|
|
60
|
+
[](https://opensource.org/licenses/MIT)
|
|
61
|
+
|
|
62
|
+
## Features
|
|
63
|
+
|
|
64
|
+
- **Project Management**: Create, push, pull, and manage Workato projects
|
|
65
|
+
- **Recipe Operations**: Validate, start, stop, and manage recipes
|
|
66
|
+
- **Connection Management**: Create and manage OAuth connections
|
|
67
|
+
- **API Integration**: Manage API clients, collections, and endpoints
|
|
68
|
+
- **AI Agent Support**: Built-in documentation and guide system
|
|
69
|
+
|
|
70
|
+
# Quick Start Guide
|
|
71
|
+
|
|
72
|
+
Get the Workato CLI running in 5 minutes.
|
|
73
|
+
|
|
74
|
+
## Prerequisites
|
|
75
|
+
|
|
76
|
+
- Python 3.11+
|
|
77
|
+
- Workato account with API token
|
|
78
|
+
|
|
79
|
+
### Getting Your API Token
|
|
80
|
+
1. Log into your Workato account
|
|
81
|
+
1. Navigate to **Workspace Admin** → **API clients**
|
|
82
|
+
1. Click **Create API client**
|
|
83
|
+
1. Fill out information about the client, click **Create client**
|
|
84
|
+
1. Copy the generated token (starts with `wrkatrial-` for trial accounts or `wrkprod-` for production)
|
|
85
|
+
|
|
86
|
+
## Installation
|
|
87
|
+
|
|
88
|
+
### From PyPI (Coming Soon)
|
|
89
|
+
```bash
|
|
90
|
+
pip install workato-platform-cli
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### From Source
|
|
94
|
+
```bash
|
|
95
|
+
git clone https://github.com/workato-devs/workato-platform-cli.git
|
|
96
|
+
cd workato-platform-cli
|
|
97
|
+
make install
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Having issues? See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md) for troubleshooting.
|
|
101
|
+
|
|
102
|
+
## Setup
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
# Initialize CLI (will prompt for API token and region)
|
|
106
|
+
workato init
|
|
107
|
+
|
|
108
|
+
# Verify your workspace
|
|
109
|
+
workato workspace
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
## First Commands
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# List available commands
|
|
117
|
+
workato --help
|
|
118
|
+
|
|
119
|
+
# List your recipes
|
|
120
|
+
workato recipes list
|
|
121
|
+
|
|
122
|
+
# List your connections
|
|
123
|
+
workato connections list
|
|
124
|
+
|
|
125
|
+
# Check project status
|
|
126
|
+
workato workspace
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Next Steps
|
|
130
|
+
|
|
131
|
+
- **Need detailed commands?** → See [COMMAND_REFERENCE.md](/docs/COMMAND_REFERENCE.md)
|
|
132
|
+
- **Want real-world examples?** → See [USE_CASES.md](/docs/USE_CASES.md)
|
|
133
|
+
- **Looking for sample recipes?** → See [examples/](/docs/examples/)
|
|
134
|
+
- **Installation issues?** → See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md)
|
|
135
|
+
- **Looking for all documentation?** → See [INDEX.md](/docs/INDEX.md)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
## Quick Recipe Workflow
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
# 1. Validate a recipe file
|
|
142
|
+
workato recipes validate --path ./my-recipe.json
|
|
143
|
+
|
|
144
|
+
# 2. Push changes to Workato
|
|
145
|
+
workato push
|
|
146
|
+
|
|
147
|
+
# 3. Pull latest from remote
|
|
148
|
+
workato pull
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
You're ready to go!
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
## Contributing to the CLI
|
|
155
|
+
|
|
156
|
+
These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations.
|
|
157
|
+
|
|
158
|
+
### For Development
|
|
159
|
+
```bash
|
|
160
|
+
# Setup (with uv - recommended)
|
|
161
|
+
make install-dev
|
|
162
|
+
|
|
163
|
+
# Run all checks
|
|
164
|
+
make check # linting, formatting, type checking
|
|
165
|
+
make test # run tests
|
|
166
|
+
make test-cov # run tests with coverage
|
|
167
|
+
|
|
168
|
+
# Development workflow
|
|
169
|
+
make format # auto-format code
|
|
170
|
+
make lint # check code quality
|
|
171
|
+
make build # build distribution packages
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
### Tech Stack
|
|
176
|
+
- **🐍 Python 3.11+** with full type annotations
|
|
177
|
+
- **⚡ uv** for fast dependency management
|
|
178
|
+
- **🔍 mypy** for static type checking
|
|
179
|
+
- **🧹 ruff** for linting and formatting
|
|
180
|
+
- **✅ pytest** for testing
|
|
181
|
+
- **🔧 pre-commit** for git hooks
|
|
182
|
+
|
|
183
|
+
## License
|
|
184
|
+
|
|
185
|
+
MIT License
|