Metadata-Version: 2.4
Name: workiva_chains_client
Version: 0.1.0
Summary: Unofficial Python client for the Workiva Chains API
Author: Unofficial workiva-chains-client maintainer
License: Apache-2.0
Keywords: workiva,chains,api-client,wdesk,automation,unofficial
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
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: license-file

# workiva-chains-client
This API is used to manage the execution of OneCloud chains and fetch metadata about your OneCloud workspaces.

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

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

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

Once published:

```sh
pip install workiva-chains-client
```

For local development, install in editable mode from the project root:

```sh
pip install -e .
```

Then import the package:
```python
import workiva_chains_client
```

### 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 workiva_chains_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import workiva_chains_client
from workiva_chains_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://h.app.wdesk.com/s/wdata/oc/api
# See configuration.py for a list of all supported configuration parameters.
configuration = workiva_chains_client.Configuration(
    host = "https://h.app.wdesk.com/s/wdata/oc/api"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with workiva_chains_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = workiva_chains_client.ChainApi(api_client)
    chain_id = '54865' # str | The ID of the Chain.
    wk_target_workspace = 'wk_target_workspace_example' # str | The `wk-target-workspace` header is only required for requests made by a service provider application. This does not apply to the majority of Workiva Chains API users. This header specifies the ID of the target workspace on which the service provider application wishes to take action. This workspace must be managed by the service provider.  (optional)

    try:
        # Export a chain
        api_response = api_instance.export_chain(chain_id, wk_target_workspace=wk_target_workspace)
        print("The response of ChainApi->export_chain:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ChainApi->export_chain: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://h.app.wdesk.com/s/wdata/oc/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ChainApi* | [**export_chain**](docs/ChainApi.md#export_chain) | **POST** /v1/chains/{chain_id}/export | Export a chain
*ChainApi* | [**get_chain**](docs/ChainApi.md#get_chain) | **GET** /v1/metadata/environment/{environment_id}/chain/{chain_id} | Return chain properties
*ChainApi* | [**get_chains**](docs/ChainApi.md#get_chains) | **GET** /v1/metadata/environment/{environment_id}/chain | Return a list of chains for an environment
*ChainApi* | [**get_commands**](docs/ChainApi.md#get_commands) | **GET** /v1/metadata/environment/{environment_id}/chain/{chain_id}/command | Return command properties
*ChainApi* | [**import_chain**](docs/ChainApi.md#import_chain) | **POST** /v1/environments/{environment_id}/import_chain | Import a chain
*ChainApi* | [**publish_chain**](docs/ChainApi.md#publish_chain) | **POST** /v1/chains/{chain_id}/publish | Publish a chain
*ChainApi* | [**search_chains**](docs/ChainApi.md#search_chains) | **GET** /v1/metadata/chains/search | Search chains
*DataprepApi* | [**publish**](docs/DataprepApi.md#publish) | **POST** /v1/dataprep/mapping_groups/{mappingGroupGuid}/publish | Publish draft version of a mapping group
*DataprepApi* | [**update_rules**](docs/DataprepApi.md#update_rules) | **POST** /v1/dataprep/mapping_groups/{mappingGroupGuid}/update_rules | Update mapping group rules
*EnvironmentApi* | [**get_environment**](docs/EnvironmentApi.md#get_environment) | **GET** /v1/metadata/workspace/{workspace_id}/environment/{environment_id} | Return environment properties
*EnvironmentApi* | [**get_environments**](docs/EnvironmentApi.md#get_environments) | **GET** /v1/metadata/workspace/{workspace_id}/environment | Return a list of environments for a workspace
*ExecutionApi* | [**chain_filter_search**](docs/ExecutionApi.md#chain_filter_search) | **GET** /v1/execute/chain_run/search | Search previous chain runs
*ExecutionApi* | [**chain_inputs_search**](docs/ExecutionApi.md#chain_inputs_search) | **GET** /v1/execute/environment/{environment_id}/chain/inputs_search | Search previous chain runs for an input value
*ExecutionApi* | [**chain_run_history**](docs/ExecutionApi.md#chain_run_history) | **GET** /v1/execute/environment/{environment_id}/chain/{chain_id}/history | Return run history for a chain
*ExecutionApi* | [**get_chain_run**](docs/ExecutionApi.md#get_chain_run) | **GET** /v1/execute/chain_run/{chain_run_id} | Return chain run properties
*ExecutionApi* | [**get_chain_run_nodes**](docs/ExecutionApi.md#get_chain_run_nodes) | **GET** /v1/execute/chain_run/{chain_run_id}/nodes | Return chain run properties with nodes
*ExecutionApi* | [**start_chain**](docs/ExecutionApi.md#start_chain) | **POST** /v1/execute/environment/{environment_id}/chain/{chain_id}/start | Execute a chain
*ExecutionApi* | [**stop_chain**](docs/ExecutionApi.md#stop_chain) | **POST** /v1/execute/chain_run/{chain_run_id}/stop | Stop a running chain
*SecurityApi* | [**get_authorizations_activity**](docs/SecurityApi.md#get_authorizations_activity) | **GET** /v1/security/authorizations_activity | Return a list of authorization activities
*SecurityApi* | [**get_login_activity**](docs/SecurityApi.md#get_login_activity) | **GET** /v1/security/login_activity | Return a list of login activity events
*SecurityApi* | [**get_permissions**](docs/SecurityApi.md#get_permissions) | **GET** /v1/security/permissions | Return a list of all permissions for a company
*SecurityApi* | [**get_user**](docs/SecurityApi.md#get_user) | **GET** /v1/security/users/{userId} | Return user properties
*SecurityApi* | [**get_user_group**](docs/SecurityApi.md#get_user_group) | **GET** /v1/security/user_groups/{userGroupId} | Return user group properties
*SecurityApi* | [**get_user_group_permissions**](docs/SecurityApi.md#get_user_group_permissions) | **GET** /v1/security/user_groups/{userGroupId}/permissions | Return a list of permissions for a user group
*SecurityApi* | [**get_user_groups**](docs/SecurityApi.md#get_user_groups) | **GET** /v1/security/user_groups | Return a list of all user groups
*SecurityApi* | [**get_user_user_groups**](docs/SecurityApi.md#get_user_user_groups) | **GET** /v1/security/users/{userId}/groups | Return a list of user groups
*SecurityApi* | [**get_users**](docs/SecurityApi.md#get_users) | **GET** /v1/security/users | Return a list of users
*WorkspaceApi* | [**get_workspace**](docs/WorkspaceApi.md#get_workspace) | **GET** /v1/metadata/workspace/{workspace_id} | Return workspace properties
*WorkspaceApi* | [**get_workspaces**](docs/WorkspaceApi.md#get_workspaces) | **GET** /v1/metadata/workspace | Return a list of workspaces


## Documentation For Models

 - [Activity](docs/Activity.md)
 - [ActivityParameters](docs/ActivityParameters.md)
 - [ActivityResponse](docs/ActivityResponse.md)
 - [Chain](docs/Chain.md)
 - [ChainResponse](docs/ChainResponse.md)
 - [ChainRun](docs/ChainRun.md)
 - [ChainRunNode](docs/ChainRunNode.md)
 - [ChainRunNodeResult](docs/ChainRunNodeResult.md)
 - [ChainRunNodeResultOutputVariables](docs/ChainRunNodeResultOutputVariables.md)
 - [ChainRunPage](docs/ChainRunPage.md)
 - [ChainRunPageResponse](docs/ChainRunPageResponse.md)
 - [ChainRunResponse](docs/ChainRunResponse.md)
 - [ChainRunWithNodes](docs/ChainRunWithNodes.md)
 - [ChainRunWithNodesResponse](docs/ChainRunWithNodesResponse.md)
 - [ChainRuntimeInputsInner](docs/ChainRuntimeInputsInner.md)
 - [ChainSchedule](docs/ChainSchedule.md)
 - [ChainScheduleProperties](docs/ChainScheduleProperties.md)
 - [ChainsEnvironmentResponse](docs/ChainsEnvironmentResponse.md)
 - [ChainsResponse](docs/ChainsResponse.md)
 - [Combinator](docs/Combinator.md)
 - [Command](docs/Command.md)
 - [CommandsResponse](docs/CommandsResponse.md)
 - [Condition](docs/Condition.md)
 - [ConditionGroup](docs/ConditionGroup.md)
 - [ConditionalOperator](docs/ConditionalOperator.md)
 - [Conditions](docs/Conditions.md)
 - [Environment](docs/Environment.md)
 - [EnvironmentChain](docs/EnvironmentChain.md)
 - [EnvironmentResponse](docs/EnvironmentResponse.md)
 - [EnvironmentSettings](docs/EnvironmentSettings.md)
 - [EnvironmentsResponse](docs/EnvironmentsResponse.md)
 - [ErrorWithLineNumber](docs/ErrorWithLineNumber.md)
 - [ErrorWithoutLineNumber](docs/ErrorWithoutLineNumber.md)
 - [LoginActivity](docs/LoginActivity.md)
 - [LoginActivityResponse](docs/LoginActivityResponse.md)
 - [MappingRule](docs/MappingRule.md)
 - [MappingRuleUploadResult](docs/MappingRuleUploadResult.md)
 - [Permission](docs/Permission.md)
 - [PermissionsResponse](docs/PermissionsResponse.md)
 - [PublishChainRequest](docs/PublishChainRequest.md)
 - [SingleError](docs/SingleError.md)
 - [StartChainRequest](docs/StartChainRequest.md)
 - [User](docs/User.md)
 - [UserGroup](docs/UserGroup.md)
 - [UserGroupResponse](docs/UserGroupResponse.md)
 - [UserGroupsResponse](docs/UserGroupsResponse.md)
 - [UserResponse](docs/UserResponse.md)
 - [UsersResponse](docs/UsersResponse.md)
 - [Variable](docs/Variable.md)
 - [Workspace](docs/Workspace.md)
 - [WorkspaceResponse](docs/WorkspaceResponse.md)
 - [WorkspacesResponse](docs/WorkspacesResponse.md)


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


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

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: N/A


## Author

platformsupport@workiva.com


