# wrk-platform-sdk
The Wrk API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded requests and responses. It uses standard HTTP response codes, authentication, and verbs.
Please note you need will an API key with the appropriate access to use the following APIs. The API key can be obtained from [this page](https://account.wrk.com/api-key) in your Wrk account. To elevate access to your account, please [contact your Sales team](https://www.wrk.com/meet-automation-expert).
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 3.2.2
- Package version: 3.2.2
- Generator version: 7.16.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.9+
## 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import wrk_platform_sdk
```
### 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 wrk_platform_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import wrk_platform_sdk
from wrk_platform_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://account.wrk.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = wrk_platform_sdk.Configuration(
host = "https://account.wrk.com/api/v1"
)
# 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 wrk_platform_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = wrk_platform_sdk.ConnectedAccountsApi(api_client)
create_connected_account_request = wrk_platform_sdk.CreateConnectedAccountRequest() # CreateConnectedAccountRequest | Create a new Connected Account by providing the Connected Account details (optional)
try:
# Create Connected Account
api_response = api_instance.create_connected_account(create_connected_account_request=create_connected_account_request)
print("The response of ConnectedAccountsApi->create_connected_account:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ConnectedAccountsApi->create_connected_account: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://account.wrk.com/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConnectedAccountsApi* | [**create_connected_account**](docs/ConnectedAccountsApi.md#create_connected_account) | **POST** /connected-account | Create Connected Account
*ConnectedAccountsApi* | [**get_connected_account**](docs/ConnectedAccountsApi.md#get_connected_account) | **GET** /connected-account/{connected_account_id} | Fetch Connected Account
*ConnectedAccountsApi* | [**get_connected_accounts**](docs/ConnectedAccountsApi.md#get_connected_accounts) | **GET** /connected-account | Fetch Connected Accounts
*ConnectedAccountsApi* | [**update_connected_account**](docs/ConnectedAccountsApi.md#update_connected_account) | **PUT** /connected-account/{connected_account_id} | Update Connected Account
*LaunchActivitiesApi* | [**get_launch_activities**](docs/LaunchActivitiesApi.md#get_launch_activities) | **GET** /launch/{launch_id}/activity | Get Wrkflow Launch Activities
*LaunchesApi* | [**get_launch_by_id**](docs/LaunchesApi.md#get_launch_by_id) | **GET** /launch/{launch_id} | Fetch a specific Wrkflow Launch
*LaunchesApi* | [**get_launches**](docs/LaunchesApi.md#get_launches) | **GET** /launch | Fetch multiple Wrkflow Launches
*LaunchesApi* | [**launch_wrkflow**](docs/LaunchesApi.md#launch_wrkflow) | **POST** /wrkflow/{wrkflow_uuid}/launch | Launch a Wrkflow
*LaunchesApi* | [**launch_wrkflow_sync**](docs/LaunchesApi.md#launch_wrkflow_sync) | **POST** /wrkflow/{wrkflow_uuid}/launch-sync | Launches the wrkflow via a POST request and returns the result of the wrkflow, or a default response if no results were produced within the specified timeout.
*LaunchesApi* | [**pause_launch**](docs/LaunchesApi.md#pause_launch) | **POST** /launch/{launch_id}/pause | Pause a Wrkflow Launch
*LaunchesApi* | [**resume_launch**](docs/LaunchesApi.md#resume_launch) | **POST** /launch/{launch_id}/resume | Resume a Wrkflow Launch
*WebhooksApi* | [**execute_webhook_sync**](docs/WebhooksApi.md#execute_webhook_sync) | **POST** /webhook/{webhook_uuid}/execute-sync | Executes a previously-configured webhook via a POST request and returns the result of the execution, or a default response if no results were produced within the specified timeout.
*WrkActionResourcesApi* | [**get_action_applications**](docs/WrkActionResourcesApi.md#get_action_applications) | **GET** /action-application | Fetch Action Applications
*WrkActionResourcesApi* | [**get_credentials**](docs/WrkActionResourcesApi.md#get_credentials) | **GET** /credential | Fetch Credentials
*WrkActionResourcesApi* | [**get_outcomes**](docs/WrkActionResourcesApi.md#get_outcomes) | **GET** /outcome | Fetch Outcomes
*WrkActionResourcesApi* | [**get_wrk_actions**](docs/WrkActionResourcesApi.md#get_wrk_actions) | **GET** /wrk-action | Fetch Wrk Actions
*WrkflowsApi* | [**create_wrkflow**](docs/WrkflowsApi.md#create_wrkflow) | **POST** /wrkflow | Create or update a Wrkflow
*WrkflowsApi* | [**get_wrkflow_by_uuid**](docs/WrkflowsApi.md#get_wrkflow_by_uuid) | **GET** /wrkflow/{wrkflow_uuid} | Fetch a specific Wrkflow
*WrkflowsApi* | [**get_wrkflows**](docs/WrkflowsApi.md#get_wrkflows) | **GET** /wrkflow | Fetch multiple Wrkflows
## Documentation For Models
- [ActionApplication](docs/ActionApplication.md)
- [ActionApplicationSpec](docs/ActionApplicationSpec.md)
- [ConnectedAccount](docs/ConnectedAccount.md)
- [CreateConnectedAccountAcceptedResponse](docs/CreateConnectedAccountAcceptedResponse.md)
- [CreateConnectedAccountCreatedResponse](docs/CreateConnectedAccountCreatedResponse.md)
- [CreateConnectedAccountRequest](docs/CreateConnectedAccountRequest.md)
- [CreateWrkflowResponse](docs/CreateWrkflowResponse.md)
- [Credential](docs/Credential.md)
- [CredentialSpec](docs/CredentialSpec.md)
- [GetActionApplicationsResponse](docs/GetActionApplicationsResponse.md)
- [GetConnectedAccountResponse](docs/GetConnectedAccountResponse.md)
- [GetConnectedAccountsResponse](docs/GetConnectedAccountsResponse.md)
- [GetCredentialsResponse](docs/GetCredentialsResponse.md)
- [GetLaunchActivitiesResponse](docs/GetLaunchActivitiesResponse.md)
- [GetLaunchByIdResponse](docs/GetLaunchByIdResponse.md)
- [GetLaunchesResponse](docs/GetLaunchesResponse.md)
- [GetOutcomesResponse](docs/GetOutcomesResponse.md)
- [GetWrkActionsResponse](docs/GetWrkActionsResponse.md)
- [GetWrkflowByUuidResponse](docs/GetWrkflowByUuidResponse.md)
- [GetWrkflowsResponse](docs/GetWrkflowsResponse.md)
- [Launch](docs/Launch.md)
- [LaunchActivity](docs/LaunchActivity.md)
- [LaunchActivityAttachmentsInner](docs/LaunchActivityAttachmentsInner.md)
- [LaunchPriority](docs/LaunchPriority.md)
- [LaunchState](docs/LaunchState.md)
- [LaunchStatus](docs/LaunchStatus.md)
- [LaunchWrkflowRequest](docs/LaunchWrkflowRequest.md)
- [LaunchWrkflowResponse](docs/LaunchWrkflowResponse.md)
- [LaunchWrkflowSync202Response](docs/LaunchWrkflowSync202Response.md)
- [LaunchWrkflowSyncRequest](docs/LaunchWrkflowSyncRequest.md)
- [Outcome](docs/Outcome.md)
- [OutcomeSpec](docs/OutcomeSpec.md)
- [UpdateConnectedAccountRequest](docs/UpdateConnectedAccountRequest.md)
- [WrkAction](docs/WrkAction.md)
- [WrkActionDefinition](docs/WrkActionDefinition.md)
- [WrkActionLink](docs/WrkActionLink.md)
- [WrkActionResourceMetadata](docs/WrkActionResourceMetadata.md)
- [WrkActionResourceReference](docs/WrkActionResourceReference.md)
- [WrkActionSpec](docs/WrkActionSpec.md)
- [WrkActionSpecCost](docs/WrkActionSpecCost.md)
- [WrkError](docs/WrkError.md)
- [WrkErrorDetails](docs/WrkErrorDetails.md)
- [Wrkflow](docs/Wrkflow.md)
- [WrkflowDefinition](docs/WrkflowDefinition.md)
- [WrkflowSchedule](docs/WrkflowSchedule.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**: Authorization
- **Location**: HTTP header
## Author
support@wrk.com
Raw data
{
"_id": null,
"home_page": null,
"name": "wrk-platform-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Wrk Automation Platform - API v1",
"author": "OpenAPI Generator community",
"author_email": "OpenAPI Generator Community <support@wrk.com>",
"download_url": "https://files.pythonhosted.org/packages/85/b8/1d5fff0be56c99875aad87bfc6825fc673463002925aecc108414c21d661/wrk_platform_sdk-3.2.2.tar.gz",
"platform": null,
"description": "# wrk-platform-sdk\nThe Wrk API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded requests and responses. It uses standard HTTP response codes, authentication, and verbs.\n\nPlease note you need will an API key with the appropriate access to use the following APIs. The API key can be obtained from [this page](https://account.wrk.com/api-key) in your Wrk account. To elevate access to your account, please [contact your Sales team](https://www.wrk.com/meet-automation-expert).\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 3.2.2\n- Package version: 3.2.2\n- Generator version: 7.16.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport wrk_platform_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport wrk_platform_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport wrk_platform_sdk\nfrom wrk_platform_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://account.wrk.com/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = wrk_platform_sdk.Configuration(\n host = \"https://account.wrk.com/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith wrk_platform_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = wrk_platform_sdk.ConnectedAccountsApi(api_client)\n create_connected_account_request = wrk_platform_sdk.CreateConnectedAccountRequest() # CreateConnectedAccountRequest | Create a new Connected Account by providing the Connected Account details (optional)\n\n try:\n # Create Connected Account\n api_response = api_instance.create_connected_account(create_connected_account_request=create_connected_account_request)\n print(\"The response of ConnectedAccountsApi->create_connected_account:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ConnectedAccountsApi->create_connected_account: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://account.wrk.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ConnectedAccountsApi* | [**create_connected_account**](docs/ConnectedAccountsApi.md#create_connected_account) | **POST** /connected-account | Create Connected Account\n*ConnectedAccountsApi* | [**get_connected_account**](docs/ConnectedAccountsApi.md#get_connected_account) | **GET** /connected-account/{connected_account_id} | Fetch Connected Account\n*ConnectedAccountsApi* | [**get_connected_accounts**](docs/ConnectedAccountsApi.md#get_connected_accounts) | **GET** /connected-account | Fetch Connected Accounts\n*ConnectedAccountsApi* | [**update_connected_account**](docs/ConnectedAccountsApi.md#update_connected_account) | **PUT** /connected-account/{connected_account_id} | Update Connected Account\n*LaunchActivitiesApi* | [**get_launch_activities**](docs/LaunchActivitiesApi.md#get_launch_activities) | **GET** /launch/{launch_id}/activity | Get Wrkflow Launch Activities\n*LaunchesApi* | [**get_launch_by_id**](docs/LaunchesApi.md#get_launch_by_id) | **GET** /launch/{launch_id} | Fetch a specific Wrkflow Launch\n*LaunchesApi* | [**get_launches**](docs/LaunchesApi.md#get_launches) | **GET** /launch | Fetch multiple Wrkflow Launches\n*LaunchesApi* | [**launch_wrkflow**](docs/LaunchesApi.md#launch_wrkflow) | **POST** /wrkflow/{wrkflow_uuid}/launch | Launch a Wrkflow\n*LaunchesApi* | [**launch_wrkflow_sync**](docs/LaunchesApi.md#launch_wrkflow_sync) | **POST** /wrkflow/{wrkflow_uuid}/launch-sync | Launches the wrkflow via a POST request and returns the result of the wrkflow, or a default response if no results were produced within the specified timeout.\n*LaunchesApi* | [**pause_launch**](docs/LaunchesApi.md#pause_launch) | **POST** /launch/{launch_id}/pause | Pause a Wrkflow Launch\n*LaunchesApi* | [**resume_launch**](docs/LaunchesApi.md#resume_launch) | **POST** /launch/{launch_id}/resume | Resume a Wrkflow Launch\n*WebhooksApi* | [**execute_webhook_sync**](docs/WebhooksApi.md#execute_webhook_sync) | **POST** /webhook/{webhook_uuid}/execute-sync | Executes a previously-configured webhook via a POST request and returns the result of the execution, or a default response if no results were produced within the specified timeout.\n*WrkActionResourcesApi* | [**get_action_applications**](docs/WrkActionResourcesApi.md#get_action_applications) | **GET** /action-application | Fetch Action Applications\n*WrkActionResourcesApi* | [**get_credentials**](docs/WrkActionResourcesApi.md#get_credentials) | **GET** /credential | Fetch Credentials\n*WrkActionResourcesApi* | [**get_outcomes**](docs/WrkActionResourcesApi.md#get_outcomes) | **GET** /outcome | Fetch Outcomes\n*WrkActionResourcesApi* | [**get_wrk_actions**](docs/WrkActionResourcesApi.md#get_wrk_actions) | **GET** /wrk-action | Fetch Wrk Actions\n*WrkflowsApi* | [**create_wrkflow**](docs/WrkflowsApi.md#create_wrkflow) | **POST** /wrkflow | Create or update a Wrkflow\n*WrkflowsApi* | [**get_wrkflow_by_uuid**](docs/WrkflowsApi.md#get_wrkflow_by_uuid) | **GET** /wrkflow/{wrkflow_uuid} | Fetch a specific Wrkflow\n*WrkflowsApi* | [**get_wrkflows**](docs/WrkflowsApi.md#get_wrkflows) | **GET** /wrkflow | Fetch multiple Wrkflows\n\n\n## Documentation For Models\n\n - [ActionApplication](docs/ActionApplication.md)\n - [ActionApplicationSpec](docs/ActionApplicationSpec.md)\n - [ConnectedAccount](docs/ConnectedAccount.md)\n - [CreateConnectedAccountAcceptedResponse](docs/CreateConnectedAccountAcceptedResponse.md)\n - [CreateConnectedAccountCreatedResponse](docs/CreateConnectedAccountCreatedResponse.md)\n - [CreateConnectedAccountRequest](docs/CreateConnectedAccountRequest.md)\n - [CreateWrkflowResponse](docs/CreateWrkflowResponse.md)\n - [Credential](docs/Credential.md)\n - [CredentialSpec](docs/CredentialSpec.md)\n - [GetActionApplicationsResponse](docs/GetActionApplicationsResponse.md)\n - [GetConnectedAccountResponse](docs/GetConnectedAccountResponse.md)\n - [GetConnectedAccountsResponse](docs/GetConnectedAccountsResponse.md)\n - [GetCredentialsResponse](docs/GetCredentialsResponse.md)\n - [GetLaunchActivitiesResponse](docs/GetLaunchActivitiesResponse.md)\n - [GetLaunchByIdResponse](docs/GetLaunchByIdResponse.md)\n - [GetLaunchesResponse](docs/GetLaunchesResponse.md)\n - [GetOutcomesResponse](docs/GetOutcomesResponse.md)\n - [GetWrkActionsResponse](docs/GetWrkActionsResponse.md)\n - [GetWrkflowByUuidResponse](docs/GetWrkflowByUuidResponse.md)\n - [GetWrkflowsResponse](docs/GetWrkflowsResponse.md)\n - [Launch](docs/Launch.md)\n - [LaunchActivity](docs/LaunchActivity.md)\n - [LaunchActivityAttachmentsInner](docs/LaunchActivityAttachmentsInner.md)\n - [LaunchPriority](docs/LaunchPriority.md)\n - [LaunchState](docs/LaunchState.md)\n - [LaunchStatus](docs/LaunchStatus.md)\n - [LaunchWrkflowRequest](docs/LaunchWrkflowRequest.md)\n - [LaunchWrkflowResponse](docs/LaunchWrkflowResponse.md)\n - [LaunchWrkflowSync202Response](docs/LaunchWrkflowSync202Response.md)\n - [LaunchWrkflowSyncRequest](docs/LaunchWrkflowSyncRequest.md)\n - [Outcome](docs/Outcome.md)\n - [OutcomeSpec](docs/OutcomeSpec.md)\n - [UpdateConnectedAccountRequest](docs/UpdateConnectedAccountRequest.md)\n - [WrkAction](docs/WrkAction.md)\n - [WrkActionDefinition](docs/WrkActionDefinition.md)\n - [WrkActionLink](docs/WrkActionLink.md)\n - [WrkActionResourceMetadata](docs/WrkActionResourceMetadata.md)\n - [WrkActionResourceReference](docs/WrkActionResourceReference.md)\n - [WrkActionSpec](docs/WrkActionSpec.md)\n - [WrkActionSpecCost](docs/WrkActionSpecCost.md)\n - [WrkError](docs/WrkError.md)\n - [WrkErrorDetails](docs/WrkErrorDetails.md)\n - [Wrkflow](docs/Wrkflow.md)\n - [WrkflowDefinition](docs/WrkflowDefinition.md)\n - [WrkflowSchedule](docs/WrkflowSchedule.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\nsupport@wrk.com\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Wrk Automation Platform - API v1",
"version": "3.2.2",
"project_urls": {
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" wrk automation platform - api v1"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "97edbe0dbd60e07d0ff22ee517c91ca0dcdfaddc21f6554c6fd983be89da39ba",
"md5": "df900d6a367932f6cc0f273708468f7c",
"sha256": "dc0f3c16f54d994be8f4526648d82970057340abe403ba9ecccd106e5d24f44d"
},
"downloads": -1,
"filename": "wrk_platform_sdk-3.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df900d6a367932f6cc0f273708468f7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 119690,
"upload_time": "2025-08-29T15:08:33",
"upload_time_iso_8601": "2025-08-29T15:08:33.655218Z",
"url": "https://files.pythonhosted.org/packages/97/ed/be0dbd60e07d0ff22ee517c91ca0dcdfaddc21f6554c6fd983be89da39ba/wrk_platform_sdk-3.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "85b81d5fff0be56c99875aad87bfc6825fc673463002925aecc108414c21d661",
"md5": "268c2b7cbec1b724ee5e1e8300f19336",
"sha256": "1d3b698ef7094204233933a88e98b02b4297be96211492e9bd22c12578641883"
},
"downloads": -1,
"filename": "wrk_platform_sdk-3.2.2.tar.gz",
"has_sig": false,
"md5_digest": "268c2b7cbec1b724ee5e1e8300f19336",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 59991,
"upload_time": "2025-08-29T15:08:34",
"upload_time_iso_8601": "2025-08-29T15:08:34.924690Z",
"url": "https://files.pythonhosted.org/packages/85/b8/1d5fff0be56c99875aad87bfc6825fc673463002925aecc108414c21d661/wrk_platform_sdk-3.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 15:08:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "wrk-platform-sdk"
}
JSON
