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,1197 @@
|
|
|
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
|
+
import warnings
|
|
15
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
16
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
|
+
from typing_extensions import Annotated
|
|
18
|
+
|
|
19
|
+
from pydantic import Field, StrictBool, StrictBytes, StrictInt, StrictStr
|
|
20
|
+
from typing import Optional, Tuple, Union
|
|
21
|
+
from typing_extensions import Annotated
|
|
22
|
+
from workato_platform_cli.client.workato_api.models.package_details_response import PackageDetailsResponse
|
|
23
|
+
from workato_platform_cli.client.workato_api.models.package_response import PackageResponse
|
|
24
|
+
|
|
25
|
+
from workato_platform_cli.client.workato_api.api_client import ApiClient, RequestSerialized
|
|
26
|
+
from workato_platform_cli.client.workato_api.api_response import ApiResponse
|
|
27
|
+
from workato_platform_cli.client.workato_api.rest import RESTResponseType
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
class PackagesApi:
|
|
31
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
32
|
+
Ref: https://openapi-generator.tech
|
|
33
|
+
|
|
34
|
+
Do not edit the class manually.
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
def __init__(self, api_client=None) -> None:
|
|
38
|
+
if api_client is None:
|
|
39
|
+
api_client = ApiClient.get_default()
|
|
40
|
+
self.api_client = api_client
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
@validate_call
|
|
44
|
+
async def download_package(
|
|
45
|
+
self,
|
|
46
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
47
|
+
_request_timeout: Union[
|
|
48
|
+
None,
|
|
49
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
50
|
+
Tuple[
|
|
51
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
52
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
53
|
+
]
|
|
54
|
+
] = None,
|
|
55
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
56
|
+
_content_type: Optional[StrictStr] = None,
|
|
57
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
58
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
59
|
+
) -> bytearray:
|
|
60
|
+
"""Download package
|
|
61
|
+
|
|
62
|
+
Downloads a package. Returns a redirect to the package content or the binary content directly. Use the -L flag in cURL to follow redirects.
|
|
63
|
+
|
|
64
|
+
:param package_id: Package ID (required)
|
|
65
|
+
:type package_id: int
|
|
66
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
67
|
+
number provided, it will be total request
|
|
68
|
+
timeout. It can also be a pair (tuple) of
|
|
69
|
+
(connection, read) timeouts.
|
|
70
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
71
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
72
|
+
request; this effectively ignores the
|
|
73
|
+
authentication in the spec for a single request.
|
|
74
|
+
:type _request_auth: dict, optional
|
|
75
|
+
:param _content_type: force content-type for the request.
|
|
76
|
+
:type _content_type: str, Optional
|
|
77
|
+
:param _headers: set to override the headers for a single
|
|
78
|
+
request; this effectively ignores the headers
|
|
79
|
+
in the spec for a single request.
|
|
80
|
+
:type _headers: dict, optional
|
|
81
|
+
:param _host_index: set to override the host_index for a single
|
|
82
|
+
request; this effectively ignores the host_index
|
|
83
|
+
in the spec for a single request.
|
|
84
|
+
:type _host_index: int, optional
|
|
85
|
+
:return: Returns the result object.
|
|
86
|
+
""" # noqa: E501
|
|
87
|
+
|
|
88
|
+
_param = self._download_package_serialize(
|
|
89
|
+
package_id=package_id,
|
|
90
|
+
_request_auth=_request_auth,
|
|
91
|
+
_content_type=_content_type,
|
|
92
|
+
_headers=_headers,
|
|
93
|
+
_host_index=_host_index
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
97
|
+
'200': "bytearray",
|
|
98
|
+
'302': None,
|
|
99
|
+
'401': "Error",
|
|
100
|
+
'404': None,
|
|
101
|
+
}
|
|
102
|
+
response_data = await self.api_client.call_api(
|
|
103
|
+
*_param,
|
|
104
|
+
_request_timeout=_request_timeout
|
|
105
|
+
)
|
|
106
|
+
await response_data.read()
|
|
107
|
+
return self.api_client.response_deserialize(
|
|
108
|
+
response_data=response_data,
|
|
109
|
+
response_types_map=_response_types_map,
|
|
110
|
+
).data
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
@validate_call
|
|
114
|
+
async def download_package_with_http_info(
|
|
115
|
+
self,
|
|
116
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
117
|
+
_request_timeout: Union[
|
|
118
|
+
None,
|
|
119
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
120
|
+
Tuple[
|
|
121
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
122
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
123
|
+
]
|
|
124
|
+
] = None,
|
|
125
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
126
|
+
_content_type: Optional[StrictStr] = None,
|
|
127
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
128
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
129
|
+
) -> ApiResponse[bytearray]:
|
|
130
|
+
"""Download package
|
|
131
|
+
|
|
132
|
+
Downloads a package. Returns a redirect to the package content or the binary content directly. Use the -L flag in cURL to follow redirects.
|
|
133
|
+
|
|
134
|
+
:param package_id: Package ID (required)
|
|
135
|
+
:type package_id: int
|
|
136
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
137
|
+
number provided, it will be total request
|
|
138
|
+
timeout. It can also be a pair (tuple) of
|
|
139
|
+
(connection, read) timeouts.
|
|
140
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
141
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
142
|
+
request; this effectively ignores the
|
|
143
|
+
authentication in the spec for a single request.
|
|
144
|
+
:type _request_auth: dict, optional
|
|
145
|
+
:param _content_type: force content-type for the request.
|
|
146
|
+
:type _content_type: str, Optional
|
|
147
|
+
:param _headers: set to override the headers for a single
|
|
148
|
+
request; this effectively ignores the headers
|
|
149
|
+
in the spec for a single request.
|
|
150
|
+
:type _headers: dict, optional
|
|
151
|
+
:param _host_index: set to override the host_index for a single
|
|
152
|
+
request; this effectively ignores the host_index
|
|
153
|
+
in the spec for a single request.
|
|
154
|
+
:type _host_index: int, optional
|
|
155
|
+
:return: Returns the result object.
|
|
156
|
+
""" # noqa: E501
|
|
157
|
+
|
|
158
|
+
_param = self._download_package_serialize(
|
|
159
|
+
package_id=package_id,
|
|
160
|
+
_request_auth=_request_auth,
|
|
161
|
+
_content_type=_content_type,
|
|
162
|
+
_headers=_headers,
|
|
163
|
+
_host_index=_host_index
|
|
164
|
+
)
|
|
165
|
+
|
|
166
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
167
|
+
'200': "bytearray",
|
|
168
|
+
'302': None,
|
|
169
|
+
'401': "Error",
|
|
170
|
+
'404': None,
|
|
171
|
+
}
|
|
172
|
+
response_data = await self.api_client.call_api(
|
|
173
|
+
*_param,
|
|
174
|
+
_request_timeout=_request_timeout
|
|
175
|
+
)
|
|
176
|
+
await response_data.read()
|
|
177
|
+
return self.api_client.response_deserialize(
|
|
178
|
+
response_data=response_data,
|
|
179
|
+
response_types_map=_response_types_map,
|
|
180
|
+
)
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
@validate_call
|
|
184
|
+
async def download_package_without_preload_content(
|
|
185
|
+
self,
|
|
186
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
187
|
+
_request_timeout: Union[
|
|
188
|
+
None,
|
|
189
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
190
|
+
Tuple[
|
|
191
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
192
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
193
|
+
]
|
|
194
|
+
] = None,
|
|
195
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
196
|
+
_content_type: Optional[StrictStr] = None,
|
|
197
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
198
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
199
|
+
) -> RESTResponseType:
|
|
200
|
+
"""Download package
|
|
201
|
+
|
|
202
|
+
Downloads a package. Returns a redirect to the package content or the binary content directly. Use the -L flag in cURL to follow redirects.
|
|
203
|
+
|
|
204
|
+
:param package_id: Package ID (required)
|
|
205
|
+
:type package_id: int
|
|
206
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
207
|
+
number provided, it will be total request
|
|
208
|
+
timeout. It can also be a pair (tuple) of
|
|
209
|
+
(connection, read) timeouts.
|
|
210
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
211
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
212
|
+
request; this effectively ignores the
|
|
213
|
+
authentication in the spec for a single request.
|
|
214
|
+
:type _request_auth: dict, optional
|
|
215
|
+
:param _content_type: force content-type for the request.
|
|
216
|
+
:type _content_type: str, Optional
|
|
217
|
+
:param _headers: set to override the headers for a single
|
|
218
|
+
request; this effectively ignores the headers
|
|
219
|
+
in the spec for a single request.
|
|
220
|
+
:type _headers: dict, optional
|
|
221
|
+
:param _host_index: set to override the host_index for a single
|
|
222
|
+
request; this effectively ignores the host_index
|
|
223
|
+
in the spec for a single request.
|
|
224
|
+
:type _host_index: int, optional
|
|
225
|
+
:return: Returns the result object.
|
|
226
|
+
""" # noqa: E501
|
|
227
|
+
|
|
228
|
+
_param = self._download_package_serialize(
|
|
229
|
+
package_id=package_id,
|
|
230
|
+
_request_auth=_request_auth,
|
|
231
|
+
_content_type=_content_type,
|
|
232
|
+
_headers=_headers,
|
|
233
|
+
_host_index=_host_index
|
|
234
|
+
)
|
|
235
|
+
|
|
236
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
237
|
+
'200': "bytearray",
|
|
238
|
+
'302': None,
|
|
239
|
+
'401': "Error",
|
|
240
|
+
'404': None,
|
|
241
|
+
}
|
|
242
|
+
response_data = await self.api_client.call_api(
|
|
243
|
+
*_param,
|
|
244
|
+
_request_timeout=_request_timeout
|
|
245
|
+
)
|
|
246
|
+
return response_data.response
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
def _download_package_serialize(
|
|
250
|
+
self,
|
|
251
|
+
package_id,
|
|
252
|
+
_request_auth,
|
|
253
|
+
_content_type,
|
|
254
|
+
_headers,
|
|
255
|
+
_host_index,
|
|
256
|
+
) -> RequestSerialized:
|
|
257
|
+
|
|
258
|
+
_host = None
|
|
259
|
+
|
|
260
|
+
_collection_formats: Dict[str, str] = {
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
_path_params: Dict[str, str] = {}
|
|
264
|
+
_query_params: List[Tuple[str, str]] = []
|
|
265
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
266
|
+
_form_params: List[Tuple[str, str]] = []
|
|
267
|
+
_files: Dict[
|
|
268
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
269
|
+
] = {}
|
|
270
|
+
_body_params: Optional[bytes] = None
|
|
271
|
+
|
|
272
|
+
# process the path parameters
|
|
273
|
+
if package_id is not None:
|
|
274
|
+
_path_params['package_id'] = package_id
|
|
275
|
+
# process the query parameters
|
|
276
|
+
# process the header parameters
|
|
277
|
+
# process the form parameters
|
|
278
|
+
# process the body parameter
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
# set the HTTP header `Accept`
|
|
282
|
+
if 'Accept' not in _header_params:
|
|
283
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
284
|
+
[
|
|
285
|
+
'application/zip',
|
|
286
|
+
'application/octet-stream',
|
|
287
|
+
'application/json'
|
|
288
|
+
]
|
|
289
|
+
)
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
# authentication setting
|
|
293
|
+
_auth_settings: List[str] = [
|
|
294
|
+
'BearerAuth'
|
|
295
|
+
]
|
|
296
|
+
|
|
297
|
+
return self.api_client.param_serialize(
|
|
298
|
+
method='GET',
|
|
299
|
+
resource_path='/api/packages/{package_id}/download',
|
|
300
|
+
path_params=_path_params,
|
|
301
|
+
query_params=_query_params,
|
|
302
|
+
header_params=_header_params,
|
|
303
|
+
body=_body_params,
|
|
304
|
+
post_params=_form_params,
|
|
305
|
+
files=_files,
|
|
306
|
+
auth_settings=_auth_settings,
|
|
307
|
+
collection_formats=_collection_formats,
|
|
308
|
+
_host=_host,
|
|
309
|
+
_request_auth=_request_auth
|
|
310
|
+
)
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
@validate_call
|
|
316
|
+
async def export_package(
|
|
317
|
+
self,
|
|
318
|
+
id: Annotated[StrictStr, Field(description="Export manifest ID")],
|
|
319
|
+
_request_timeout: Union[
|
|
320
|
+
None,
|
|
321
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
322
|
+
Tuple[
|
|
323
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
324
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
325
|
+
]
|
|
326
|
+
] = None,
|
|
327
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
328
|
+
_content_type: Optional[StrictStr] = None,
|
|
329
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
330
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
331
|
+
) -> PackageResponse:
|
|
332
|
+
"""Export a package based on a manifest
|
|
333
|
+
|
|
334
|
+
Export a package based on a manifest. **ENDPOINT PRIVILEGES ALSO PROVIDE ACCESS TO ASSETS** When you provide an API client with privileges to this endpoint, the API client is also granted the ability to view other assets like recipes, lookup tables, Event topics, and message templates by examining the resulting zip file. This is an asynchronous request. Use GET package by ID endpoint to get details of the exported package. **INCLUDE TAGS WHEN CREATING THE EXPORT MANIFEST** To include tags in the exported package, set the include_tags attribute to true when calling the Create an export manifest endpoint.
|
|
335
|
+
|
|
336
|
+
:param id: Export manifest ID (required)
|
|
337
|
+
:type id: str
|
|
338
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
339
|
+
number provided, it will be total request
|
|
340
|
+
timeout. It can also be a pair (tuple) of
|
|
341
|
+
(connection, read) timeouts.
|
|
342
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
343
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
344
|
+
request; this effectively ignores the
|
|
345
|
+
authentication in the spec for a single request.
|
|
346
|
+
:type _request_auth: dict, optional
|
|
347
|
+
:param _content_type: force content-type for the request.
|
|
348
|
+
:type _content_type: str, Optional
|
|
349
|
+
:param _headers: set to override the headers for a single
|
|
350
|
+
request; this effectively ignores the headers
|
|
351
|
+
in the spec for a single request.
|
|
352
|
+
:type _headers: dict, optional
|
|
353
|
+
:param _host_index: set to override the host_index for a single
|
|
354
|
+
request; this effectively ignores the host_index
|
|
355
|
+
in the spec for a single request.
|
|
356
|
+
:type _host_index: int, optional
|
|
357
|
+
:return: Returns the result object.
|
|
358
|
+
""" # noqa: E501
|
|
359
|
+
|
|
360
|
+
_param = self._export_package_serialize(
|
|
361
|
+
id=id,
|
|
362
|
+
_request_auth=_request_auth,
|
|
363
|
+
_content_type=_content_type,
|
|
364
|
+
_headers=_headers,
|
|
365
|
+
_host_index=_host_index
|
|
366
|
+
)
|
|
367
|
+
|
|
368
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
369
|
+
'200': "PackageResponse",
|
|
370
|
+
'401': "Error",
|
|
371
|
+
}
|
|
372
|
+
response_data = await self.api_client.call_api(
|
|
373
|
+
*_param,
|
|
374
|
+
_request_timeout=_request_timeout
|
|
375
|
+
)
|
|
376
|
+
await response_data.read()
|
|
377
|
+
return self.api_client.response_deserialize(
|
|
378
|
+
response_data=response_data,
|
|
379
|
+
response_types_map=_response_types_map,
|
|
380
|
+
).data
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
@validate_call
|
|
384
|
+
async def export_package_with_http_info(
|
|
385
|
+
self,
|
|
386
|
+
id: Annotated[StrictStr, Field(description="Export manifest ID")],
|
|
387
|
+
_request_timeout: Union[
|
|
388
|
+
None,
|
|
389
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
390
|
+
Tuple[
|
|
391
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
392
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
393
|
+
]
|
|
394
|
+
] = None,
|
|
395
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
396
|
+
_content_type: Optional[StrictStr] = None,
|
|
397
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
398
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
399
|
+
) -> ApiResponse[PackageResponse]:
|
|
400
|
+
"""Export a package based on a manifest
|
|
401
|
+
|
|
402
|
+
Export a package based on a manifest. **ENDPOINT PRIVILEGES ALSO PROVIDE ACCESS TO ASSETS** When you provide an API client with privileges to this endpoint, the API client is also granted the ability to view other assets like recipes, lookup tables, Event topics, and message templates by examining the resulting zip file. This is an asynchronous request. Use GET package by ID endpoint to get details of the exported package. **INCLUDE TAGS WHEN CREATING THE EXPORT MANIFEST** To include tags in the exported package, set the include_tags attribute to true when calling the Create an export manifest endpoint.
|
|
403
|
+
|
|
404
|
+
:param id: Export manifest ID (required)
|
|
405
|
+
:type id: str
|
|
406
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
407
|
+
number provided, it will be total request
|
|
408
|
+
timeout. It can also be a pair (tuple) of
|
|
409
|
+
(connection, read) timeouts.
|
|
410
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
411
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
412
|
+
request; this effectively ignores the
|
|
413
|
+
authentication in the spec for a single request.
|
|
414
|
+
:type _request_auth: dict, optional
|
|
415
|
+
:param _content_type: force content-type for the request.
|
|
416
|
+
:type _content_type: str, Optional
|
|
417
|
+
:param _headers: set to override the headers for a single
|
|
418
|
+
request; this effectively ignores the headers
|
|
419
|
+
in the spec for a single request.
|
|
420
|
+
:type _headers: dict, optional
|
|
421
|
+
:param _host_index: set to override the host_index for a single
|
|
422
|
+
request; this effectively ignores the host_index
|
|
423
|
+
in the spec for a single request.
|
|
424
|
+
:type _host_index: int, optional
|
|
425
|
+
:return: Returns the result object.
|
|
426
|
+
""" # noqa: E501
|
|
427
|
+
|
|
428
|
+
_param = self._export_package_serialize(
|
|
429
|
+
id=id,
|
|
430
|
+
_request_auth=_request_auth,
|
|
431
|
+
_content_type=_content_type,
|
|
432
|
+
_headers=_headers,
|
|
433
|
+
_host_index=_host_index
|
|
434
|
+
)
|
|
435
|
+
|
|
436
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
437
|
+
'200': "PackageResponse",
|
|
438
|
+
'401': "Error",
|
|
439
|
+
}
|
|
440
|
+
response_data = await self.api_client.call_api(
|
|
441
|
+
*_param,
|
|
442
|
+
_request_timeout=_request_timeout
|
|
443
|
+
)
|
|
444
|
+
await response_data.read()
|
|
445
|
+
return self.api_client.response_deserialize(
|
|
446
|
+
response_data=response_data,
|
|
447
|
+
response_types_map=_response_types_map,
|
|
448
|
+
)
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
@validate_call
|
|
452
|
+
async def export_package_without_preload_content(
|
|
453
|
+
self,
|
|
454
|
+
id: Annotated[StrictStr, Field(description="Export manifest ID")],
|
|
455
|
+
_request_timeout: Union[
|
|
456
|
+
None,
|
|
457
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
458
|
+
Tuple[
|
|
459
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
460
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
461
|
+
]
|
|
462
|
+
] = None,
|
|
463
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
464
|
+
_content_type: Optional[StrictStr] = None,
|
|
465
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
466
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
467
|
+
) -> RESTResponseType:
|
|
468
|
+
"""Export a package based on a manifest
|
|
469
|
+
|
|
470
|
+
Export a package based on a manifest. **ENDPOINT PRIVILEGES ALSO PROVIDE ACCESS TO ASSETS** When you provide an API client with privileges to this endpoint, the API client is also granted the ability to view other assets like recipes, lookup tables, Event topics, and message templates by examining the resulting zip file. This is an asynchronous request. Use GET package by ID endpoint to get details of the exported package. **INCLUDE TAGS WHEN CREATING THE EXPORT MANIFEST** To include tags in the exported package, set the include_tags attribute to true when calling the Create an export manifest endpoint.
|
|
471
|
+
|
|
472
|
+
:param id: Export manifest ID (required)
|
|
473
|
+
:type id: str
|
|
474
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
475
|
+
number provided, it will be total request
|
|
476
|
+
timeout. It can also be a pair (tuple) of
|
|
477
|
+
(connection, read) timeouts.
|
|
478
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
479
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
480
|
+
request; this effectively ignores the
|
|
481
|
+
authentication in the spec for a single request.
|
|
482
|
+
:type _request_auth: dict, optional
|
|
483
|
+
:param _content_type: force content-type for the request.
|
|
484
|
+
:type _content_type: str, Optional
|
|
485
|
+
:param _headers: set to override the headers for a single
|
|
486
|
+
request; this effectively ignores the headers
|
|
487
|
+
in the spec for a single request.
|
|
488
|
+
:type _headers: dict, optional
|
|
489
|
+
:param _host_index: set to override the host_index for a single
|
|
490
|
+
request; this effectively ignores the host_index
|
|
491
|
+
in the spec for a single request.
|
|
492
|
+
:type _host_index: int, optional
|
|
493
|
+
:return: Returns the result object.
|
|
494
|
+
""" # noqa: E501
|
|
495
|
+
|
|
496
|
+
_param = self._export_package_serialize(
|
|
497
|
+
id=id,
|
|
498
|
+
_request_auth=_request_auth,
|
|
499
|
+
_content_type=_content_type,
|
|
500
|
+
_headers=_headers,
|
|
501
|
+
_host_index=_host_index
|
|
502
|
+
)
|
|
503
|
+
|
|
504
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
505
|
+
'200': "PackageResponse",
|
|
506
|
+
'401': "Error",
|
|
507
|
+
}
|
|
508
|
+
response_data = await self.api_client.call_api(
|
|
509
|
+
*_param,
|
|
510
|
+
_request_timeout=_request_timeout
|
|
511
|
+
)
|
|
512
|
+
return response_data.response
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
def _export_package_serialize(
|
|
516
|
+
self,
|
|
517
|
+
id,
|
|
518
|
+
_request_auth,
|
|
519
|
+
_content_type,
|
|
520
|
+
_headers,
|
|
521
|
+
_host_index,
|
|
522
|
+
) -> RequestSerialized:
|
|
523
|
+
|
|
524
|
+
_host = None
|
|
525
|
+
|
|
526
|
+
_collection_formats: Dict[str, str] = {
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
_path_params: Dict[str, str] = {}
|
|
530
|
+
_query_params: List[Tuple[str, str]] = []
|
|
531
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
532
|
+
_form_params: List[Tuple[str, str]] = []
|
|
533
|
+
_files: Dict[
|
|
534
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
535
|
+
] = {}
|
|
536
|
+
_body_params: Optional[bytes] = None
|
|
537
|
+
|
|
538
|
+
# process the path parameters
|
|
539
|
+
if id is not None:
|
|
540
|
+
_path_params['id'] = id
|
|
541
|
+
# process the query parameters
|
|
542
|
+
# process the header parameters
|
|
543
|
+
# process the form parameters
|
|
544
|
+
# process the body parameter
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
# set the HTTP header `Accept`
|
|
548
|
+
if 'Accept' not in _header_params:
|
|
549
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
550
|
+
[
|
|
551
|
+
'application/json'
|
|
552
|
+
]
|
|
553
|
+
)
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
# authentication setting
|
|
557
|
+
_auth_settings: List[str] = [
|
|
558
|
+
'BearerAuth'
|
|
559
|
+
]
|
|
560
|
+
|
|
561
|
+
return self.api_client.param_serialize(
|
|
562
|
+
method='POST',
|
|
563
|
+
resource_path='/api/packages/export/{id}',
|
|
564
|
+
path_params=_path_params,
|
|
565
|
+
query_params=_query_params,
|
|
566
|
+
header_params=_header_params,
|
|
567
|
+
body=_body_params,
|
|
568
|
+
post_params=_form_params,
|
|
569
|
+
files=_files,
|
|
570
|
+
auth_settings=_auth_settings,
|
|
571
|
+
collection_formats=_collection_formats,
|
|
572
|
+
_host=_host,
|
|
573
|
+
_request_auth=_request_auth
|
|
574
|
+
)
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
@validate_call
|
|
580
|
+
async def get_package(
|
|
581
|
+
self,
|
|
582
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
583
|
+
_request_timeout: Union[
|
|
584
|
+
None,
|
|
585
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
586
|
+
Tuple[
|
|
587
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
588
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
589
|
+
]
|
|
590
|
+
] = None,
|
|
591
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
592
|
+
_content_type: Optional[StrictStr] = None,
|
|
593
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
594
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
595
|
+
) -> PackageDetailsResponse:
|
|
596
|
+
"""Get package details
|
|
597
|
+
|
|
598
|
+
Get details of an imported or exported package including status
|
|
599
|
+
|
|
600
|
+
:param package_id: Package ID (required)
|
|
601
|
+
:type package_id: int
|
|
602
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
603
|
+
number provided, it will be total request
|
|
604
|
+
timeout. It can also be a pair (tuple) of
|
|
605
|
+
(connection, read) timeouts.
|
|
606
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
607
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
608
|
+
request; this effectively ignores the
|
|
609
|
+
authentication in the spec for a single request.
|
|
610
|
+
:type _request_auth: dict, optional
|
|
611
|
+
:param _content_type: force content-type for the request.
|
|
612
|
+
:type _content_type: str, Optional
|
|
613
|
+
:param _headers: set to override the headers for a single
|
|
614
|
+
request; this effectively ignores the headers
|
|
615
|
+
in the spec for a single request.
|
|
616
|
+
:type _headers: dict, optional
|
|
617
|
+
:param _host_index: set to override the host_index for a single
|
|
618
|
+
request; this effectively ignores the host_index
|
|
619
|
+
in the spec for a single request.
|
|
620
|
+
:type _host_index: int, optional
|
|
621
|
+
:return: Returns the result object.
|
|
622
|
+
""" # noqa: E501
|
|
623
|
+
|
|
624
|
+
_param = self._get_package_serialize(
|
|
625
|
+
package_id=package_id,
|
|
626
|
+
_request_auth=_request_auth,
|
|
627
|
+
_content_type=_content_type,
|
|
628
|
+
_headers=_headers,
|
|
629
|
+
_host_index=_host_index
|
|
630
|
+
)
|
|
631
|
+
|
|
632
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
633
|
+
'200': "PackageDetailsResponse",
|
|
634
|
+
'401': "Error",
|
|
635
|
+
'404': None,
|
|
636
|
+
}
|
|
637
|
+
response_data = await self.api_client.call_api(
|
|
638
|
+
*_param,
|
|
639
|
+
_request_timeout=_request_timeout
|
|
640
|
+
)
|
|
641
|
+
await response_data.read()
|
|
642
|
+
return self.api_client.response_deserialize(
|
|
643
|
+
response_data=response_data,
|
|
644
|
+
response_types_map=_response_types_map,
|
|
645
|
+
).data
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
@validate_call
|
|
649
|
+
async def get_package_with_http_info(
|
|
650
|
+
self,
|
|
651
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
652
|
+
_request_timeout: Union[
|
|
653
|
+
None,
|
|
654
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
655
|
+
Tuple[
|
|
656
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
657
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
658
|
+
]
|
|
659
|
+
] = None,
|
|
660
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
661
|
+
_content_type: Optional[StrictStr] = None,
|
|
662
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
663
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
664
|
+
) -> ApiResponse[PackageDetailsResponse]:
|
|
665
|
+
"""Get package details
|
|
666
|
+
|
|
667
|
+
Get details of an imported or exported package including status
|
|
668
|
+
|
|
669
|
+
:param package_id: Package ID (required)
|
|
670
|
+
:type package_id: int
|
|
671
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
672
|
+
number provided, it will be total request
|
|
673
|
+
timeout. It can also be a pair (tuple) of
|
|
674
|
+
(connection, read) timeouts.
|
|
675
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
676
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
677
|
+
request; this effectively ignores the
|
|
678
|
+
authentication in the spec for a single request.
|
|
679
|
+
:type _request_auth: dict, optional
|
|
680
|
+
:param _content_type: force content-type for the request.
|
|
681
|
+
:type _content_type: str, Optional
|
|
682
|
+
:param _headers: set to override the headers for a single
|
|
683
|
+
request; this effectively ignores the headers
|
|
684
|
+
in the spec for a single request.
|
|
685
|
+
:type _headers: dict, optional
|
|
686
|
+
:param _host_index: set to override the host_index for a single
|
|
687
|
+
request; this effectively ignores the host_index
|
|
688
|
+
in the spec for a single request.
|
|
689
|
+
:type _host_index: int, optional
|
|
690
|
+
:return: Returns the result object.
|
|
691
|
+
""" # noqa: E501
|
|
692
|
+
|
|
693
|
+
_param = self._get_package_serialize(
|
|
694
|
+
package_id=package_id,
|
|
695
|
+
_request_auth=_request_auth,
|
|
696
|
+
_content_type=_content_type,
|
|
697
|
+
_headers=_headers,
|
|
698
|
+
_host_index=_host_index
|
|
699
|
+
)
|
|
700
|
+
|
|
701
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
702
|
+
'200': "PackageDetailsResponse",
|
|
703
|
+
'401': "Error",
|
|
704
|
+
'404': None,
|
|
705
|
+
}
|
|
706
|
+
response_data = await self.api_client.call_api(
|
|
707
|
+
*_param,
|
|
708
|
+
_request_timeout=_request_timeout
|
|
709
|
+
)
|
|
710
|
+
await response_data.read()
|
|
711
|
+
return self.api_client.response_deserialize(
|
|
712
|
+
response_data=response_data,
|
|
713
|
+
response_types_map=_response_types_map,
|
|
714
|
+
)
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
@validate_call
|
|
718
|
+
async def get_package_without_preload_content(
|
|
719
|
+
self,
|
|
720
|
+
package_id: Annotated[StrictInt, Field(description="Package ID")],
|
|
721
|
+
_request_timeout: Union[
|
|
722
|
+
None,
|
|
723
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
724
|
+
Tuple[
|
|
725
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
726
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
727
|
+
]
|
|
728
|
+
] = None,
|
|
729
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
730
|
+
_content_type: Optional[StrictStr] = None,
|
|
731
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
732
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
733
|
+
) -> RESTResponseType:
|
|
734
|
+
"""Get package details
|
|
735
|
+
|
|
736
|
+
Get details of an imported or exported package including status
|
|
737
|
+
|
|
738
|
+
:param package_id: Package ID (required)
|
|
739
|
+
:type package_id: int
|
|
740
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
741
|
+
number provided, it will be total request
|
|
742
|
+
timeout. It can also be a pair (tuple) of
|
|
743
|
+
(connection, read) timeouts.
|
|
744
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
745
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
746
|
+
request; this effectively ignores the
|
|
747
|
+
authentication in the spec for a single request.
|
|
748
|
+
:type _request_auth: dict, optional
|
|
749
|
+
:param _content_type: force content-type for the request.
|
|
750
|
+
:type _content_type: str, Optional
|
|
751
|
+
:param _headers: set to override the headers for a single
|
|
752
|
+
request; this effectively ignores the headers
|
|
753
|
+
in the spec for a single request.
|
|
754
|
+
:type _headers: dict, optional
|
|
755
|
+
:param _host_index: set to override the host_index for a single
|
|
756
|
+
request; this effectively ignores the host_index
|
|
757
|
+
in the spec for a single request.
|
|
758
|
+
:type _host_index: int, optional
|
|
759
|
+
:return: Returns the result object.
|
|
760
|
+
""" # noqa: E501
|
|
761
|
+
|
|
762
|
+
_param = self._get_package_serialize(
|
|
763
|
+
package_id=package_id,
|
|
764
|
+
_request_auth=_request_auth,
|
|
765
|
+
_content_type=_content_type,
|
|
766
|
+
_headers=_headers,
|
|
767
|
+
_host_index=_host_index
|
|
768
|
+
)
|
|
769
|
+
|
|
770
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
771
|
+
'200': "PackageDetailsResponse",
|
|
772
|
+
'401': "Error",
|
|
773
|
+
'404': None,
|
|
774
|
+
}
|
|
775
|
+
response_data = await self.api_client.call_api(
|
|
776
|
+
*_param,
|
|
777
|
+
_request_timeout=_request_timeout
|
|
778
|
+
)
|
|
779
|
+
return response_data.response
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
def _get_package_serialize(
|
|
783
|
+
self,
|
|
784
|
+
package_id,
|
|
785
|
+
_request_auth,
|
|
786
|
+
_content_type,
|
|
787
|
+
_headers,
|
|
788
|
+
_host_index,
|
|
789
|
+
) -> RequestSerialized:
|
|
790
|
+
|
|
791
|
+
_host = None
|
|
792
|
+
|
|
793
|
+
_collection_formats: Dict[str, str] = {
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
_path_params: Dict[str, str] = {}
|
|
797
|
+
_query_params: List[Tuple[str, str]] = []
|
|
798
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
799
|
+
_form_params: List[Tuple[str, str]] = []
|
|
800
|
+
_files: Dict[
|
|
801
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
802
|
+
] = {}
|
|
803
|
+
_body_params: Optional[bytes] = None
|
|
804
|
+
|
|
805
|
+
# process the path parameters
|
|
806
|
+
if package_id is not None:
|
|
807
|
+
_path_params['package_id'] = package_id
|
|
808
|
+
# process the query parameters
|
|
809
|
+
# process the header parameters
|
|
810
|
+
# process the form parameters
|
|
811
|
+
# process the body parameter
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
# set the HTTP header `Accept`
|
|
815
|
+
if 'Accept' not in _header_params:
|
|
816
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
817
|
+
[
|
|
818
|
+
'application/json'
|
|
819
|
+
]
|
|
820
|
+
)
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
# authentication setting
|
|
824
|
+
_auth_settings: List[str] = [
|
|
825
|
+
'BearerAuth'
|
|
826
|
+
]
|
|
827
|
+
|
|
828
|
+
return self.api_client.param_serialize(
|
|
829
|
+
method='GET',
|
|
830
|
+
resource_path='/api/packages/{package_id}',
|
|
831
|
+
path_params=_path_params,
|
|
832
|
+
query_params=_query_params,
|
|
833
|
+
header_params=_header_params,
|
|
834
|
+
body=_body_params,
|
|
835
|
+
post_params=_form_params,
|
|
836
|
+
files=_files,
|
|
837
|
+
auth_settings=_auth_settings,
|
|
838
|
+
collection_formats=_collection_formats,
|
|
839
|
+
_host=_host,
|
|
840
|
+
_request_auth=_request_auth
|
|
841
|
+
)
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
@validate_call
|
|
847
|
+
async def import_package(
|
|
848
|
+
self,
|
|
849
|
+
id: Annotated[StrictInt, Field(description="Folder ID")],
|
|
850
|
+
body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
|
|
851
|
+
restart_recipes: Annotated[Optional[StrictBool], Field(description="Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided. ")] = None,
|
|
852
|
+
include_tags: Annotated[Optional[StrictBool], Field(description="Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false. ")] = None,
|
|
853
|
+
folder_id_for_home_assets: Annotated[Optional[StrictInt], Field(description="The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project. ")] = None,
|
|
854
|
+
_request_timeout: Union[
|
|
855
|
+
None,
|
|
856
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
857
|
+
Tuple[
|
|
858
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
859
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
860
|
+
]
|
|
861
|
+
] = None,
|
|
862
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
863
|
+
_content_type: Optional[StrictStr] = None,
|
|
864
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
865
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
866
|
+
) -> PackageResponse:
|
|
867
|
+
"""Import a package into a folder
|
|
868
|
+
|
|
869
|
+
Import a package in zip file format into a folder. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports. This is an asynchronous request. Use GET package by ID endpoint to get details of the imported package. The input (zip file) is an application/octet-stream payload containing package content.
|
|
870
|
+
|
|
871
|
+
:param id: Folder ID (required)
|
|
872
|
+
:type id: int
|
|
873
|
+
:param body: (required)
|
|
874
|
+
:type body: bytearray
|
|
875
|
+
:param restart_recipes: Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided.
|
|
876
|
+
:type restart_recipes: bool
|
|
877
|
+
:param include_tags: Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false.
|
|
878
|
+
:type include_tags: bool
|
|
879
|
+
:param folder_id_for_home_assets: The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project.
|
|
880
|
+
:type folder_id_for_home_assets: int
|
|
881
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
882
|
+
number provided, it will be total request
|
|
883
|
+
timeout. It can also be a pair (tuple) of
|
|
884
|
+
(connection, read) timeouts.
|
|
885
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
886
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
887
|
+
request; this effectively ignores the
|
|
888
|
+
authentication in the spec for a single request.
|
|
889
|
+
:type _request_auth: dict, optional
|
|
890
|
+
:param _content_type: force content-type for the request.
|
|
891
|
+
:type _content_type: str, Optional
|
|
892
|
+
:param _headers: set to override the headers for a single
|
|
893
|
+
request; this effectively ignores the headers
|
|
894
|
+
in the spec for a single request.
|
|
895
|
+
:type _headers: dict, optional
|
|
896
|
+
:param _host_index: set to override the host_index for a single
|
|
897
|
+
request; this effectively ignores the host_index
|
|
898
|
+
in the spec for a single request.
|
|
899
|
+
:type _host_index: int, optional
|
|
900
|
+
:return: Returns the result object.
|
|
901
|
+
""" # noqa: E501
|
|
902
|
+
|
|
903
|
+
_param = self._import_package_serialize(
|
|
904
|
+
id=id,
|
|
905
|
+
body=body,
|
|
906
|
+
restart_recipes=restart_recipes,
|
|
907
|
+
include_tags=include_tags,
|
|
908
|
+
folder_id_for_home_assets=folder_id_for_home_assets,
|
|
909
|
+
_request_auth=_request_auth,
|
|
910
|
+
_content_type=_content_type,
|
|
911
|
+
_headers=_headers,
|
|
912
|
+
_host_index=_host_index
|
|
913
|
+
)
|
|
914
|
+
|
|
915
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
916
|
+
'200': "PackageResponse",
|
|
917
|
+
'400': "ValidationError",
|
|
918
|
+
'401': "Error",
|
|
919
|
+
}
|
|
920
|
+
response_data = await self.api_client.call_api(
|
|
921
|
+
*_param,
|
|
922
|
+
_request_timeout=_request_timeout
|
|
923
|
+
)
|
|
924
|
+
await response_data.read()
|
|
925
|
+
return self.api_client.response_deserialize(
|
|
926
|
+
response_data=response_data,
|
|
927
|
+
response_types_map=_response_types_map,
|
|
928
|
+
).data
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
@validate_call
|
|
932
|
+
async def import_package_with_http_info(
|
|
933
|
+
self,
|
|
934
|
+
id: Annotated[StrictInt, Field(description="Folder ID")],
|
|
935
|
+
body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
|
|
936
|
+
restart_recipes: Annotated[Optional[StrictBool], Field(description="Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided. ")] = None,
|
|
937
|
+
include_tags: Annotated[Optional[StrictBool], Field(description="Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false. ")] = None,
|
|
938
|
+
folder_id_for_home_assets: Annotated[Optional[StrictInt], Field(description="The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project. ")] = None,
|
|
939
|
+
_request_timeout: Union[
|
|
940
|
+
None,
|
|
941
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
942
|
+
Tuple[
|
|
943
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
944
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
945
|
+
]
|
|
946
|
+
] = None,
|
|
947
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
948
|
+
_content_type: Optional[StrictStr] = None,
|
|
949
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
950
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
951
|
+
) -> ApiResponse[PackageResponse]:
|
|
952
|
+
"""Import a package into a folder
|
|
953
|
+
|
|
954
|
+
Import a package in zip file format into a folder. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports. This is an asynchronous request. Use GET package by ID endpoint to get details of the imported package. The input (zip file) is an application/octet-stream payload containing package content.
|
|
955
|
+
|
|
956
|
+
:param id: Folder ID (required)
|
|
957
|
+
:type id: int
|
|
958
|
+
:param body: (required)
|
|
959
|
+
:type body: bytearray
|
|
960
|
+
:param restart_recipes: Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided.
|
|
961
|
+
:type restart_recipes: bool
|
|
962
|
+
:param include_tags: Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false.
|
|
963
|
+
:type include_tags: bool
|
|
964
|
+
:param folder_id_for_home_assets: The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project.
|
|
965
|
+
:type folder_id_for_home_assets: int
|
|
966
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
967
|
+
number provided, it will be total request
|
|
968
|
+
timeout. It can also be a pair (tuple) of
|
|
969
|
+
(connection, read) timeouts.
|
|
970
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
971
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
972
|
+
request; this effectively ignores the
|
|
973
|
+
authentication in the spec for a single request.
|
|
974
|
+
:type _request_auth: dict, optional
|
|
975
|
+
:param _content_type: force content-type for the request.
|
|
976
|
+
:type _content_type: str, Optional
|
|
977
|
+
:param _headers: set to override the headers for a single
|
|
978
|
+
request; this effectively ignores the headers
|
|
979
|
+
in the spec for a single request.
|
|
980
|
+
:type _headers: dict, optional
|
|
981
|
+
:param _host_index: set to override the host_index for a single
|
|
982
|
+
request; this effectively ignores the host_index
|
|
983
|
+
in the spec for a single request.
|
|
984
|
+
:type _host_index: int, optional
|
|
985
|
+
:return: Returns the result object.
|
|
986
|
+
""" # noqa: E501
|
|
987
|
+
|
|
988
|
+
_param = self._import_package_serialize(
|
|
989
|
+
id=id,
|
|
990
|
+
body=body,
|
|
991
|
+
restart_recipes=restart_recipes,
|
|
992
|
+
include_tags=include_tags,
|
|
993
|
+
folder_id_for_home_assets=folder_id_for_home_assets,
|
|
994
|
+
_request_auth=_request_auth,
|
|
995
|
+
_content_type=_content_type,
|
|
996
|
+
_headers=_headers,
|
|
997
|
+
_host_index=_host_index
|
|
998
|
+
)
|
|
999
|
+
|
|
1000
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1001
|
+
'200': "PackageResponse",
|
|
1002
|
+
'400': "ValidationError",
|
|
1003
|
+
'401': "Error",
|
|
1004
|
+
}
|
|
1005
|
+
response_data = await self.api_client.call_api(
|
|
1006
|
+
*_param,
|
|
1007
|
+
_request_timeout=_request_timeout
|
|
1008
|
+
)
|
|
1009
|
+
await response_data.read()
|
|
1010
|
+
return self.api_client.response_deserialize(
|
|
1011
|
+
response_data=response_data,
|
|
1012
|
+
response_types_map=_response_types_map,
|
|
1013
|
+
)
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
@validate_call
|
|
1017
|
+
async def import_package_without_preload_content(
|
|
1018
|
+
self,
|
|
1019
|
+
id: Annotated[StrictInt, Field(description="Folder ID")],
|
|
1020
|
+
body: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
|
|
1021
|
+
restart_recipes: Annotated[Optional[StrictBool], Field(description="Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided. ")] = None,
|
|
1022
|
+
include_tags: Annotated[Optional[StrictBool], Field(description="Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false. ")] = None,
|
|
1023
|
+
folder_id_for_home_assets: Annotated[Optional[StrictInt], Field(description="The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project. ")] = None,
|
|
1024
|
+
_request_timeout: Union[
|
|
1025
|
+
None,
|
|
1026
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1027
|
+
Tuple[
|
|
1028
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1029
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1030
|
+
]
|
|
1031
|
+
] = None,
|
|
1032
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1033
|
+
_content_type: Optional[StrictStr] = None,
|
|
1034
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1035
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1036
|
+
) -> RESTResponseType:
|
|
1037
|
+
"""Import a package into a folder
|
|
1038
|
+
|
|
1039
|
+
Import a package in zip file format into a folder. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports. This is an asynchronous request. Use GET package by ID endpoint to get details of the imported package. The input (zip file) is an application/octet-stream payload containing package content.
|
|
1040
|
+
|
|
1041
|
+
:param id: Folder ID (required)
|
|
1042
|
+
:type id: int
|
|
1043
|
+
:param body: (required)
|
|
1044
|
+
:type body: bytearray
|
|
1045
|
+
:param restart_recipes: Value must be true to allow the restarting of running recipes during import. Packages cannot be imported if there are running recipes and this parameter equals false or is not provided.
|
|
1046
|
+
:type restart_recipes: bool
|
|
1047
|
+
:param include_tags: Specifies whether to preserve tags assigned to assets when the package is imported into the folder. Tags are excluded from the import when set to false.
|
|
1048
|
+
:type include_tags: bool
|
|
1049
|
+
:param folder_id_for_home_assets: The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. This parameter is conditionally required if you are importing a package that contains root folder assets and your workspace Home assets folder has been converted to a Home assets project.
|
|
1050
|
+
:type folder_id_for_home_assets: int
|
|
1051
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1052
|
+
number provided, it will be total request
|
|
1053
|
+
timeout. It can also be a pair (tuple) of
|
|
1054
|
+
(connection, read) timeouts.
|
|
1055
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1056
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1057
|
+
request; this effectively ignores the
|
|
1058
|
+
authentication in the spec for a single request.
|
|
1059
|
+
:type _request_auth: dict, optional
|
|
1060
|
+
:param _content_type: force content-type for the request.
|
|
1061
|
+
:type _content_type: str, Optional
|
|
1062
|
+
:param _headers: set to override the headers for a single
|
|
1063
|
+
request; this effectively ignores the headers
|
|
1064
|
+
in the spec for a single request.
|
|
1065
|
+
:type _headers: dict, optional
|
|
1066
|
+
:param _host_index: set to override the host_index for a single
|
|
1067
|
+
request; this effectively ignores the host_index
|
|
1068
|
+
in the spec for a single request.
|
|
1069
|
+
:type _host_index: int, optional
|
|
1070
|
+
:return: Returns the result object.
|
|
1071
|
+
""" # noqa: E501
|
|
1072
|
+
|
|
1073
|
+
_param = self._import_package_serialize(
|
|
1074
|
+
id=id,
|
|
1075
|
+
body=body,
|
|
1076
|
+
restart_recipes=restart_recipes,
|
|
1077
|
+
include_tags=include_tags,
|
|
1078
|
+
folder_id_for_home_assets=folder_id_for_home_assets,
|
|
1079
|
+
_request_auth=_request_auth,
|
|
1080
|
+
_content_type=_content_type,
|
|
1081
|
+
_headers=_headers,
|
|
1082
|
+
_host_index=_host_index
|
|
1083
|
+
)
|
|
1084
|
+
|
|
1085
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1086
|
+
'200': "PackageResponse",
|
|
1087
|
+
'400': "ValidationError",
|
|
1088
|
+
'401': "Error",
|
|
1089
|
+
}
|
|
1090
|
+
response_data = await self.api_client.call_api(
|
|
1091
|
+
*_param,
|
|
1092
|
+
_request_timeout=_request_timeout
|
|
1093
|
+
)
|
|
1094
|
+
return response_data.response
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
def _import_package_serialize(
|
|
1098
|
+
self,
|
|
1099
|
+
id,
|
|
1100
|
+
body,
|
|
1101
|
+
restart_recipes,
|
|
1102
|
+
include_tags,
|
|
1103
|
+
folder_id_for_home_assets,
|
|
1104
|
+
_request_auth,
|
|
1105
|
+
_content_type,
|
|
1106
|
+
_headers,
|
|
1107
|
+
_host_index,
|
|
1108
|
+
) -> RequestSerialized:
|
|
1109
|
+
|
|
1110
|
+
_host = None
|
|
1111
|
+
|
|
1112
|
+
_collection_formats: Dict[str, str] = {
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
_path_params: Dict[str, str] = {}
|
|
1116
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1117
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1118
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1119
|
+
_files: Dict[
|
|
1120
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1121
|
+
] = {}
|
|
1122
|
+
_body_params: Optional[bytes] = None
|
|
1123
|
+
|
|
1124
|
+
# process the path parameters
|
|
1125
|
+
if id is not None:
|
|
1126
|
+
_path_params['id'] = id
|
|
1127
|
+
# process the query parameters
|
|
1128
|
+
if restart_recipes is not None:
|
|
1129
|
+
|
|
1130
|
+
_query_params.append(('restart_recipes', restart_recipes))
|
|
1131
|
+
|
|
1132
|
+
if include_tags is not None:
|
|
1133
|
+
|
|
1134
|
+
_query_params.append(('include_tags', include_tags))
|
|
1135
|
+
|
|
1136
|
+
if folder_id_for_home_assets is not None:
|
|
1137
|
+
|
|
1138
|
+
_query_params.append(('folder_id_for_home_assets', folder_id_for_home_assets))
|
|
1139
|
+
|
|
1140
|
+
# process the header parameters
|
|
1141
|
+
# process the form parameters
|
|
1142
|
+
# process the body parameter
|
|
1143
|
+
if body is not None:
|
|
1144
|
+
# convert to byte array if the input is a file name (str)
|
|
1145
|
+
if isinstance(body, str):
|
|
1146
|
+
with open(body, "rb") as _fp:
|
|
1147
|
+
_body_params = _fp.read()
|
|
1148
|
+
elif isinstance(body, tuple):
|
|
1149
|
+
# drop the filename from the tuple
|
|
1150
|
+
_body_params = body[1]
|
|
1151
|
+
else:
|
|
1152
|
+
_body_params = body
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
# set the HTTP header `Accept`
|
|
1156
|
+
if 'Accept' not in _header_params:
|
|
1157
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1158
|
+
[
|
|
1159
|
+
'application/json'
|
|
1160
|
+
]
|
|
1161
|
+
)
|
|
1162
|
+
|
|
1163
|
+
# set the HTTP header `Content-Type`
|
|
1164
|
+
if _content_type:
|
|
1165
|
+
_header_params['Content-Type'] = _content_type
|
|
1166
|
+
else:
|
|
1167
|
+
_default_content_type = (
|
|
1168
|
+
self.api_client.select_header_content_type(
|
|
1169
|
+
[
|
|
1170
|
+
'application/octet-stream'
|
|
1171
|
+
]
|
|
1172
|
+
)
|
|
1173
|
+
)
|
|
1174
|
+
if _default_content_type is not None:
|
|
1175
|
+
_header_params['Content-Type'] = _default_content_type
|
|
1176
|
+
|
|
1177
|
+
# authentication setting
|
|
1178
|
+
_auth_settings: List[str] = [
|
|
1179
|
+
'BearerAuth'
|
|
1180
|
+
]
|
|
1181
|
+
|
|
1182
|
+
return self.api_client.param_serialize(
|
|
1183
|
+
method='POST',
|
|
1184
|
+
resource_path='/api/packages/import/{id}',
|
|
1185
|
+
path_params=_path_params,
|
|
1186
|
+
query_params=_query_params,
|
|
1187
|
+
header_params=_header_params,
|
|
1188
|
+
body=_body_params,
|
|
1189
|
+
post_params=_form_params,
|
|
1190
|
+
files=_files,
|
|
1191
|
+
auth_settings=_auth_settings,
|
|
1192
|
+
collection_formats=_collection_formats,
|
|
1193
|
+
_host=_host,
|
|
1194
|
+
_request_auth=_request_auth
|
|
1195
|
+
)
|
|
1196
|
+
|
|
1197
|
+
|