Metadata-Version: 2.4
Name: kiban-workfloo
Version: 1.1.0
Summary: Workfloo API
Home-page: https://github.com/kiban-cloud/kiban-sdk
Author: kiban
Author-email: kiban <hola@kiban.com>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/kiban-cloud/kiban-sdk
Keywords: kiban,workfloo,sdk,api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# kiban-workfloo
API pública de Workfloo: ejecuta un workfloo, consulta su estatus y revisa el historial/detalle de ejecuciones.
Todos los endpoints se autentican con el header x-api-key.

Ambientes: producción en https://workfloo.kiban.com y sandbox en https://sandbox.workfloo.kiban.com.
El host sandbox activa ese modo de forma implícita y tiene precedencia: ahí el query param sandbox se ignora.
Desde el host de producción se puede forzar el modo sandbox por request con sandbox=true.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.1.0
- Generator version: 7.24.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://kiban.com](https://kiban.com)

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/kiban-cloud/kiban-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/kiban-cloud/kiban-sdk.git`)

Then import the package:
```python
import kiban.workfloo
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import kiban.workfloo
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import kiban.workfloo
from kiban.workfloo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://workfloo.kiban.com
# See configuration.py for a list of all supported configuration parameters.
configuration = kiban.workfloo.Configuration(
    host = "https://workfloo.kiban.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with kiban.workfloo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kiban.workfloo.PoolApi(api_client)
    controller_pool_model_execute = kiban.workfloo.ControllerPoolModelExecute() # ControllerPoolModelExecute | Definición del pool y escenarios
    sandbox = True # bool | Fuerza el ambiente sandbox. Se ignora en el host sandbox, donde ya es implícito (optional)

    try:
        # Ejecutar un pool
        api_response = api_instance.execute_pool(controller_pool_model_execute, sandbox=sandbox)
        print("The response of PoolApi->execute_pool:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PoolApi->execute_pool: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://workfloo.kiban.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PoolApi* | [**execute_pool**](docs/PoolApi.md#execute_pool) | **POST** /api/v1/pool | Ejecutar un pool
*WorkflooApi* | [**execute_workfloo**](docs/WorkflooApi.md#execute_workfloo) | **POST** /api/v1/workfloo | Ejecutar un workfloo
*WorkflooApi* | [**execute_workfloo_document**](docs/WorkflooApi.md#execute_workfloo_document) | **POST** /api/v1/workfloo/{id}/document | Enviar los documentos de un paso
*WorkflooApi* | [**execute_workfloo_form**](docs/WorkflooApi.md#execute_workfloo_form) | **POST** /api/v1/workfloo/{id}/form | Enviar el formulario de un paso
*WorkflooApi* | [**fallback_workfloo_otp**](docs/WorkflooApi.md#fallback_workfloo_otp) | **PATCH** /api/v1/workfloo/{id}/otp/fallback | Reenviar el código de verificación (OTP)
*WorkflooApi* | [**get_workfloo**](docs/WorkflooApi.md#get_workfloo) | **GET** /api/v1/workfloo/{id} | Detalle de una ejecución
*WorkflooApi* | [**get_workfloo_file**](docs/WorkflooApi.md#get_workfloo_file) | **GET** /api/v1/workfloo/{id}/file | Descargar un archivo de un nodo
*WorkflooApi* | [**get_workfloo_file_v2**](docs/WorkflooApi.md#get_workfloo_file_v2) | **GET** /api/v2/workfloo/{id}/file | Descargar un archivo de un nodo (v2)
*WorkflooApi* | [**get_workfloo_status**](docs/WorkflooApi.md#get_workfloo_status) | **GET** /api/v1/workfloo/status/{id} | Estatus de una ejecución
*WorkflooApi* | [**list_workfloos**](docs/WorkflooApi.md#list_workfloos) | **GET** /api/v1/workfloo | Historial de ejecuciones (v1)
*WorkflooApi* | [**list_workfloos_v2**](docs/WorkflooApi.md#list_workfloos_v2) | **GET** /api/v2/workfloo | Historial de ejecuciones (v2)
*WorkflooApi* | [**resend_workfloo_nip**](docs/WorkflooApi.md#resend_workfloo_nip) | **PATCH** /api/v1/workfloo/{id}/nip/resend | Reenviar el NIP
*WorkflooApi* | [**review_workfloo_validation**](docs/WorkflooApi.md#review_workfloo_validation) | **POST** /api/v1/workfloo/{id}/review | Revisar un paso de validación
*WorkflooApi* | [**send_workfloo_nip**](docs/WorkflooApi.md#send_workfloo_nip) | **PATCH** /api/v1/workfloo/{id}/nip/send | Enviar el NIP
*WorkflooApi* | [**submit_workfloo_correction**](docs/WorkflooApi.md#submit_workfloo_correction) | **POST** /api/v1/workfloo/{id}/correction | Enviar la corrección de un paso de validación
*WorkflooApi* | [**validate_workfloo_field**](docs/WorkflooApi.md#validate_workfloo_field) | **POST** /api/v1/workfloo/{id}/field/{fieldId}/validate | Validar un campo del formulario
*WorkflooApi* | [**validate_workfloo_nip**](docs/WorkflooApi.md#validate_workfloo_nip) | **PATCH** /api/v1/workfloo/{id}/nip/validate | Validar el NIP
*WorkflooApi* | [**validate_workfloo_otp**](docs/WorkflooApi.md#validate_workfloo_otp) | **PATCH** /api/v1/workfloo/{id}/otp/validate | Validar el código de verificación (OTP)


## Documentation For Models

 - [ControllerPoolModelExecute](docs/ControllerPoolModelExecute.md)
 - [ControllerPoolModelExecuteResponse](docs/ControllerPoolModelExecuteResponse.md)
 - [ControllerWorkflooDefinitionModelAutoFilledBy](docs/ControllerWorkflooDefinitionModelAutoFilledBy.md)
 - [ControllerWorkflooDefinitionModelDocument](docs/ControllerWorkflooDefinitionModelDocument.md)
 - [ControllerWorkflooDefinitionModelField](docs/ControllerWorkflooDefinitionModelField.md)
 - [ControllerWorkflooDefinitionModelFieldMetadata](docs/ControllerWorkflooDefinitionModelFieldMetadata.md)
 - [ControllerWorkflooDefinitionModelFieldValidator](docs/ControllerWorkflooDefinitionModelFieldValidator.md)
 - [ControllerWorkflooDefinitionModelFileDocument](docs/ControllerWorkflooDefinitionModelFileDocument.md)
 - [ControllerWorkflooDefinitionModelFileDocumentSet](docs/ControllerWorkflooDefinitionModelFileDocumentSet.md)
 - [ControllerWorkflooDefinitionModelFileMetadata](docs/ControllerWorkflooDefinitionModelFileMetadata.md)
 - [ControllerWorkflooDefinitionModelForm](docs/ControllerWorkflooDefinitionModelForm.md)
 - [ControllerWorkflooDefinitionModelFormFieldSection](docs/ControllerWorkflooDefinitionModelFormFieldSection.md)
 - [ControllerWorkflooDefinitionModelSetData](docs/ControllerWorkflooDefinitionModelSetData.md)
 - [ControllerWorkflooDefinitionModelSetDataDocument](docs/ControllerWorkflooDefinitionModelSetDataDocument.md)
 - [ControllerWorkflooDefinitionModelShow](docs/ControllerWorkflooDefinitionModelShow.md)
 - [ControllerWorkflooDefinitionModelShowIf](docs/ControllerWorkflooDefinitionModelShowIf.md)
 - [ControllerWorkflooModelApi](docs/ControllerWorkflooModelApi.md)
 - [ControllerWorkflooModelApiData](docs/ControllerWorkflooModelApiData.md)
 - [ControllerWorkflooModelApiDataResume](docs/ControllerWorkflooModelApiDataResume.md)
 - [ControllerWorkflooModelApiHttp](docs/ControllerWorkflooModelApiHttp.md)
 - [ControllerWorkflooModelData](docs/ControllerWorkflooModelData.md)
 - [ControllerWorkflooModelDecisionTree](docs/ControllerWorkflooModelDecisionTree.md)
 - [ControllerWorkflooModelDocumentsResume](docs/ControllerWorkflooModelDocumentsResume.md)
 - [ControllerWorkflooModelEvent](docs/ControllerWorkflooModelEvent.md)
 - [ControllerWorkflooModelExecute](docs/ControllerWorkflooModelExecute.md)
 - [ControllerWorkflooModelExecuteResponse](docs/ControllerWorkflooModelExecuteResponse.md)
 - [ControllerWorkflooModelFile](docs/ControllerWorkflooModelFile.md)
 - [ControllerWorkflooModelFileResponse](docs/ControllerWorkflooModelFileResponse.md)
 - [ControllerWorkflooModelFileResponseV2](docs/ControllerWorkflooModelFileResponseV2.md)
 - [ControllerWorkflooModelForm](docs/ControllerWorkflooModelForm.md)
 - [ControllerWorkflooModelFormField](docs/ControllerWorkflooModelFormField.md)
 - [ControllerWorkflooModelFormResume](docs/ControllerWorkflooModelFormResume.md)
 - [ControllerWorkflooModelLabel](docs/ControllerWorkflooModelLabel.md)
 - [ControllerWorkflooModelLink](docs/ControllerWorkflooModelLink.md)
 - [ControllerWorkflooModelLinkNipStatus](docs/ControllerWorkflooModelLinkNipStatus.md)
 - [ControllerWorkflooModelLinkResume](docs/ControllerWorkflooModelLinkResume.md)
 - [ControllerWorkflooModelNipResendRequest](docs/ControllerWorkflooModelNipResendRequest.md)
 - [ControllerWorkflooModelNipResendStatus](docs/ControllerWorkflooModelNipResendStatus.md)
 - [ControllerWorkflooModelNipSendErrorStatus](docs/ControllerWorkflooModelNipSendErrorStatus.md)
 - [ControllerWorkflooModelNipSendRequest](docs/ControllerWorkflooModelNipSendRequest.md)
 - [ControllerWorkflooModelNipValidateRequest](docs/ControllerWorkflooModelNipValidateRequest.md)
 - [ControllerWorkflooModelNipValidateResponse](docs/ControllerWorkflooModelNipValidateResponse.md)
 - [ControllerWorkflooModelNode](docs/ControllerWorkflooModelNode.md)
 - [ControllerWorkflooModelNodeDetail](docs/ControllerWorkflooModelNodeDetail.md)
 - [ControllerWorkflooModelNodeResume](docs/ControllerWorkflooModelNodeResume.md)
 - [ControllerWorkflooModelOtpValidateRequest](docs/ControllerWorkflooModelOtpValidateRequest.md)
 - [ControllerWorkflooModelPdf](docs/ControllerWorkflooModelPdf.md)
 - [ControllerWorkflooModelRejectedField](docs/ControllerWorkflooModelRejectedField.md)
 - [ControllerWorkflooModelRejection](docs/ControllerWorkflooModelRejection.md)
 - [ControllerWorkflooModelRemainingTime](docs/ControllerWorkflooModelRemainingTime.md)
 - [ControllerWorkflooModelReviewFieldRequest](docs/ControllerWorkflooModelReviewFieldRequest.md)
 - [ControllerWorkflooModelReviewRequest](docs/ControllerWorkflooModelReviewRequest.md)
 - [ControllerWorkflooModelReviewResume](docs/ControllerWorkflooModelReviewResume.md)
 - [ControllerWorkflooModelRules](docs/ControllerWorkflooModelRules.md)
 - [ControllerWorkflooModelRuleset](docs/ControllerWorkflooModelRuleset.md)
 - [ControllerWorkflooModelTimer](docs/ControllerWorkflooModelTimer.md)
 - [ControllerWorkflooModelValidateFieldRequest](docs/ControllerWorkflooModelValidateFieldRequest.md)
 - [ControllerWorkflooModelValidateFieldResponse](docs/ControllerWorkflooModelValidateFieldResponse.md)
 - [ControllerWorkflooModelValidationField](docs/ControllerWorkflooModelValidationField.md)
 - [ControllerWorkflooModelValidationResume](docs/ControllerWorkflooModelValidationResume.md)
 - [ControllerWorkflooModelValidationStatus](docs/ControllerWorkflooModelValidationStatus.md)
 - [ControllerWorkflooModelVariable](docs/ControllerWorkflooModelVariable.md)
 - [ControllerWorkflooModelVariables](docs/ControllerWorkflooModelVariables.md)
 - [ControllerWorkflooModelVerificationStatus](docs/ControllerWorkflooModelVerificationStatus.md)
 - [ControllerWorkflooModelWorkfloo](docs/ControllerWorkflooModelWorkfloo.md)
 - [ControllerWorkflooModelWorkflooListItem](docs/ControllerWorkflooModelWorkflooListItem.md)
 - [ControllerWorkflooModelWorkflooPage](docs/ControllerWorkflooModelWorkflooPage.md)
 - [ControllerWorkflooModelWorkflooResume](docs/ControllerWorkflooModelWorkflooResume.md)
 - [ControllerWorkflooModelWorkflooStatus](docs/ControllerWorkflooModelWorkflooStatus.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header


## Author

hola@kiban.com


