Metadata-Version: 2.4
Name: wdata_client
Version: 1.0.0
Summary: Wdata API
Home-page: 
Author: Workiva Inc
Author-email: Workiva Inc <platformsupport@workiva.com>
License: MIT
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Wdata API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# wdata-client
The Wdata Preparation API allow users
to import data sets from their source system, tag, organize, manipulate, share,
export, and query against the data


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

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

## 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 wdata_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 wdata_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import wdata_client
from wdata_client.rest import ApiException
from pprint import pprint

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

# 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 wdata_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wdata_client.APIHealthApi(api_client)

    try:
        # Health check
        api_response = api_instance.health_check()
        print("The response of APIHealthApi->health_check:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIHealthApi->health_check: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIHealthApi* | [**health_check**](docs/APIHealthApi.md#health_check) | **GET** /health | Health check
*AdministrativeTasksApi* | [**delete_workspace**](docs/AdministrativeTasksApi.md#delete_workspace) | **DELETE** /api/v1/admin/account | Delete a single workspace
*AdministrativeTasksApi* | [**export_workspace**](docs/AdministrativeTasksApi.md#export_workspace) | **GET** /api/v1/admin/export | Export a single workspace
*AdministrativeTasksApi* | [**find_workspace_files_by_size**](docs/AdministrativeTasksApi.md#find_workspace_files_by_size) | **GET** /api/v1/admin/usage/filesBySize | Retrieve workspace files by size
*AdministrativeTasksApi* | [**get_workspace_query_usage**](docs/AdministrativeTasksApi.md#get_workspace_query_usage) | **GET** /api/v1/admin/usage/query | Retrieve workspace query usage
*AdministrativeTasksApi* | [**get_workspace_upload_usage**](docs/AdministrativeTasksApi.md#get_workspace_upload_usage) | **GET** /api/v1/admin/usage/upload | Retrieve workspace upload usage
*AdministrativeTasksApi* | [**import_data**](docs/AdministrativeTasksApi.md#import_data) | **POST** /api/v1/admin/import | Import data
*AdministrativeTasksApi* | [**validate_files**](docs/AdministrativeTasksApi.md#validate_files) | **POST** /api/v1/admin/validation/files | Validate files
*AdministrativeTasksApi* | [**validate_tables**](docs/AdministrativeTasksApi.md#validate_tables) | **POST** /api/v1/admin/validation/tables | Validate tables
*ConnectionManagementApi* | [**get_connection**](docs/ConnectionManagementApi.md#get_connection) | **GET** /api/v1/connections/{connectionId} | Get connection details
*ConnectionManagementApi* | [**get_refresh_batch_status**](docs/ConnectionManagementApi.md#get_refresh_batch_status) | **GET** /api/v1/connections/batch/refresh/{batchId} | Gets the status of a batch refresh
*ConnectionManagementApi* | [**get_refresh_status**](docs/ConnectionManagementApi.md#get_refresh_status) | **GET** /api/v1/connections/{connectionId}/status | Get connection refresh status
*ConnectionManagementApi* | [**list_connections**](docs/ConnectionManagementApi.md#list_connections) | **GET** /api/v1/connections | List connections
*ConnectionManagementApi* | [**refresh_batch**](docs/ConnectionManagementApi.md#refresh_batch) | **POST** /api/v1/connections/batch/refresh | Refresh batch of connections
*ConnectionManagementApi* | [**refresh_connection**](docs/ConnectionManagementApi.md#refresh_connection) | **POST** /api/v1/connections/{connectionId}/refresh | Refresh connection
*FileManagementApi* | [**delete_file**](docs/FileManagementApi.md#delete_file) | **DELETE** /api/v1/file/{fileId} | Delete a single file
*FileManagementApi* | [**download_file1**](docs/FileManagementApi.md#download_file1) | **GET** /api/v1/file/{fileId}/download | Download a single file
*FileManagementApi* | [**export_file_to_spreadsheets**](docs/FileManagementApi.md#export_file_to_spreadsheets) | **POST** /api/v1/file/{fileId}/export | Export a file to spreadsheets
*FileManagementApi* | [**get_errors**](docs/FileManagementApi.md#get_errors) | **GET** /api/v1/file/{fileId}/error | Retrieve errors
*FileManagementApi* | [**get_file**](docs/FileManagementApi.md#get_file) | **GET** /api/v1/file/{fileId} | Retrieve a single file
*FileManagementApi* | [**get_files**](docs/FileManagementApi.md#get_files) | **GET** /api/v1/file | Retrieve a list of files
*FileManagementApi* | [**upload_file**](docs/FileManagementApi.md#upload_file) | **POST** /api/v1/file | Upload a single file
*FileManagementApi* | [**validate_filename**](docs/FileManagementApi.md#validate_filename) | **GET** /api/v1/file/validateName | Validate whether a file with the filename can be uploaded to the table
*FolderManagementApi* | [**create_folder**](docs/FolderManagementApi.md#create_folder) | **POST** /api/v1/folder | Create a new folder
*FolderManagementApi* | [**delete_folder**](docs/FolderManagementApi.md#delete_folder) | **DELETE** /api/v1/folder/{folderId} | Delete a single folder
*FolderManagementApi* | [**get_folder**](docs/FolderManagementApi.md#get_folder) | **GET** /api/v1/folder/{folderId} | Retrieve a single folder
*FolderManagementApi* | [**list_children**](docs/FolderManagementApi.md#list_children) | **GET** /api/v1/folder/{folderId}/children | Retrieve list of folder contents
*FolderManagementApi* | [**list_folders**](docs/FolderManagementApi.md#list_folders) | **GET** /api/v1/folder | Retrieve a list of folders
*FolderManagementApi* | [**search**](docs/FolderManagementApi.md#search) | **GET** /api/v1/entity | Search
*FolderManagementApi* | [**set_children**](docs/FolderManagementApi.md#set_children) | **POST** /api/v1/folder/{folderId}/children | Move content into a folder
*FolderManagementApi* | [**update_folder**](docs/FolderManagementApi.md#update_folder) | **PUT** /api/v1/folder/{folderId} | Update a single folder
*ParameterManagementApi* | [**create_parameter**](docs/ParameterManagementApi.md#create_parameter) | **POST** /api/v1/parameter | Create parameter
*ParameterManagementApi* | [**delete_parameter**](docs/ParameterManagementApi.md#delete_parameter) | **DELETE** /api/v1/parameter/{parameterId} | Delete Parameter
*ParameterManagementApi* | [**get_parameter**](docs/ParameterManagementApi.md#get_parameter) | **GET** /api/v1/parameter/{parameterId} | Get Parameter
*ParameterManagementApi* | [**list_parameters**](docs/ParameterManagementApi.md#list_parameters) | **GET** /api/v1/parameter | Get Parameters
*ParameterManagementApi* | [**update_parameter**](docs/ParameterManagementApi.md#update_parameter) | **PUT** /api/v1/parameter/{parameterId} | Update Parameter
*PivotViewManagementApi* | [**create_pivot_view**](docs/PivotViewManagementApi.md#create_pivot_view) | **POST** /api/v1/pivotview | Create a new pivot view
*PivotViewManagementApi* | [**delete_pivot_view**](docs/PivotViewManagementApi.md#delete_pivot_view) | **DELETE** /api/v1/pivotview/{pivotViewId} | Delete a single pivot view
*PivotViewManagementApi* | [**get_pivot_view**](docs/PivotViewManagementApi.md#get_pivot_view) | **GET** /api/v1/pivotview/{pivotViewId} | Retrieve a single pivot view
*PivotViewManagementApi* | [**list_pivot_views**](docs/PivotViewManagementApi.md#list_pivot_views) | **GET** /api/v1/pivotview | Retrieve a list of pivot views
*PivotViewManagementApi* | [**update_pivot_view**](docs/PivotViewManagementApi.md#update_pivot_view) | **PUT** /api/v1/pivotview/{pivotViewId} | Update a single pivot view
*QueryManagementApi* | [**cancel_query**](docs/QueryManagementApi.md#cancel_query) | **DELETE** /api/v1/queryresult/{queryResultId} | Cancel a running query
*QueryManagementApi* | [**create_query**](docs/QueryManagementApi.md#create_query) | **POST** /api/v1/query | Create a new query
*QueryManagementApi* | [**delete_query**](docs/QueryManagementApi.md#delete_query) | **DELETE** /api/v1/query/{queryId} | Delete a single query
*QueryManagementApi* | [**describe_query**](docs/QueryManagementApi.md#describe_query) | **POST** /api/v1/query/{queryId}/describe | List the output columns of a query
*QueryManagementApi* | [**download_query_result**](docs/QueryManagementApi.md#download_query_result) | **GET** /api/v1/queryresult/{queryResultId}/download | Download a query result
*QueryManagementApi* | [**export_query_result_to_spreadsheets**](docs/QueryManagementApi.md#export_query_result_to_spreadsheets) | **POST** /api/v1/queryresult/{queryResultId}/export | Export query result to spreadsheets
*QueryManagementApi* | [**get_dependencies**](docs/QueryManagementApi.md#get_dependencies) | **GET** /api/v1/query/{queryId}/dependencies | Retrieve dependencies
*QueryManagementApi* | [**get_query**](docs/QueryManagementApi.md#get_query) | **GET** /api/v1/query/{queryId} | Retrieve a single query
*QueryManagementApi* | [**get_query_column_data**](docs/QueryManagementApi.md#get_query_column_data) | **POST** /api/v1/query/data | Retrieve query column data
*QueryManagementApi* | [**get_query_result**](docs/QueryManagementApi.md#get_query_result) | **GET** /api/v1/queryresult/{queryResultId} | Retrieve a single query result
*QueryManagementApi* | [**get_tables_dependent_on_query**](docs/QueryManagementApi.md#get_tables_dependent_on_query) | **GET** /api/v1/query/{queryId}/dependents | Retrieve a list of dependents
*QueryManagementApi* | [**is_query_valid**](docs/QueryManagementApi.md#is_query_valid) | **POST** /api/v1/query/validation | Parses the query to determine if it is valid
*QueryManagementApi* | [**list_queries**](docs/QueryManagementApi.md#list_queries) | **GET** /api/v1/query | Retrieve list of queries
*QueryManagementApi* | [**list_query_results**](docs/QueryManagementApi.md#list_query_results) | **GET** /api/v1/queryresult | Retrieve a list of query results
*QueryManagementApi* | [**run_query**](docs/QueryManagementApi.md#run_query) | **POST** /api/v1/queryresult | Execute a query
*QueryManagementApi* | [**update_query**](docs/QueryManagementApi.md#update_query) | **PUT** /api/v1/query/{queryId} | Update a single query
*SelectListManagementApi* | [**create_select_list**](docs/SelectListManagementApi.md#create_select_list) | **POST** /api/v1/selectlist | Create a new select list
*SelectListManagementApi* | [**delete**](docs/SelectListManagementApi.md#delete) | **DELETE** /api/v1/selectlist/{selectListId} | Delete a single select list
*SelectListManagementApi* | [**get_select_list**](docs/SelectListManagementApi.md#get_select_list) | **GET** /api/v1/selectlist/{selectListId} | Retrieve a single select list
*SelectListManagementApi* | [**list_select_lists**](docs/SelectListManagementApi.md#list_select_lists) | **GET** /api/v1/selectlist | Retrieve a list of select lists
*SelectListManagementApi* | [**update_select_list**](docs/SelectListManagementApi.md#update_select_list) | **PUT** /api/v1/selectlist/{selectListId} | Update a single select list
*SharedTableManagementApi* | [**create_shared_table**](docs/SharedTableManagementApi.md#create_shared_table) | **POST** /api/v1/sharedtable | Create a new shared table
*SharedTableManagementApi* | [**delete_shared_table**](docs/SharedTableManagementApi.md#delete_shared_table) | **DELETE** /api/v1/sharedtable/{sharedTableId} | Delete a single shared table
*SharedTableManagementApi* | [**get_shared_table**](docs/SharedTableManagementApi.md#get_shared_table) | **GET** /api/v1/sharedtable/{sharedTableId} | Retrieve a single shared table
*SharedTableManagementApi* | [**list_shared_tables**](docs/SharedTableManagementApi.md#list_shared_tables) | **GET** /api/v1/sharedtable | Retrieve a list of shared tables
*TableManagementApi* | [**create_table**](docs/TableManagementApi.md#create_table) | **POST** /api/v1/table | Create a new table
*TableManagementApi* | [**delete_table**](docs/TableManagementApi.md#delete_table) | **DELETE** /api/v1/table/{tableId} | Delete a single table
*TableManagementApi* | [**get_dependents**](docs/TableManagementApi.md#get_dependents) | **GET** /api/v1/table/{tableId}/dependents | Retrieve a list of dependents
*TableManagementApi* | [**get_import_info**](docs/TableManagementApi.md#get_import_info) | **GET** /api/v1/table/{tableId}/importInfo | Retrieve import information
*TableManagementApi* | [**get_table**](docs/TableManagementApi.md#get_table) | **GET** /api/v1/table/{tableId} | Retrieve a single table
*TableManagementApi* | [**get_tables**](docs/TableManagementApi.md#get_tables) | **GET** /api/v1/table | Retrieve a list of tables
*TableManagementApi* | [**import_file**](docs/TableManagementApi.md#import_file) | **POST** /api/v1/table/{tableId}/import | Import a single file
*TableManagementApi* | [**import_from_spreadsheets**](docs/TableManagementApi.md#import_from_spreadsheets) | **POST** /api/v1/table/{tableId}/spreadsheet/import | Import from spreadsheets
*TableManagementApi* | [**unimport_file**](docs/TableManagementApi.md#unimport_file) | **DELETE** /api/v1/table/{tableId}/import/{fileId} | Unimport a single file
*TableManagementApi* | [**update_table**](docs/TableManagementApi.md#update_table) | **PUT** /api/v1/table/{tableId} | Update a single table
*TagManagementApi* | [**create_tag**](docs/TagManagementApi.md#create_tag) | **POST** /api/v1/tag | Create a new tag
*TagManagementApi* | [**delete_tag**](docs/TagManagementApi.md#delete_tag) | **DELETE** /api/v1/tag/{tagId} | Delete a single tag
*TagManagementApi* | [**list_tags**](docs/TagManagementApi.md#list_tags) | **GET** /api/v1/tag | Retrieve a list of tags
*TagManagementApi* | [**update_tag**](docs/TagManagementApi.md#update_tag) | **PUT** /api/v1/tag/{tagId} | Update a single tag
*TokenManagementApi* | [**create_token**](docs/TokenManagementApi.md#create_token) | **POST** /api/v1/token | Create a new token
*TokenManagementApi* | [**download_file**](docs/TokenManagementApi.md#download_file) | **GET** /api/v1/token/{tokenId} | Download a single file
*UtilitiesApi* | [**parse_date**](docs/UtilitiesApi.md#parse_date) | **POST** /api/v1/util/datetime | Parse a date


## Documentation For Models

 - [BaseErrorResponseDetail](docs/BaseErrorResponseDetail.md)
 - [BaseResponseCollectionFolderableDto](docs/BaseResponseCollectionFolderableDto.md)
 - [BaseResponseConnectionDto](docs/BaseResponseConnectionDto.md)
 - [BaseResponseConnectionRunDto](docs/BaseResponseConnectionRunDto.md)
 - [BaseResponseDescribeQueryResponseDto](docs/BaseResponseDescribeQueryResponseDto.md)
 - [BaseResponseFileMetaDto](docs/BaseResponseFileMetaDto.md)
 - [BaseResponseFolderDto](docs/BaseResponseFolderDto.md)
 - [BaseResponseGlobalParameterDto](docs/BaseResponseGlobalParameterDto.md)
 - [BaseResponseImportInfoDto](docs/BaseResponseImportInfoDto.md)
 - [BaseResponseLong](docs/BaseResponseLong.md)
 - [BaseResponseMapStringString](docs/BaseResponseMapStringString.md)
 - [BaseResponsePivotViewDto](docs/BaseResponsePivotViewDto.md)
 - [BaseResponseQueryColumnDataDto](docs/BaseResponseQueryColumnDataDto.md)
 - [BaseResponseQueryDto](docs/BaseResponseQueryDto.md)
 - [BaseResponseQueryResultDto](docs/BaseResponseQueryResultDto.md)
 - [BaseResponseRefreshBatchDto](docs/BaseResponseRefreshBatchDto.md)
 - [BaseResponseSelectListDto](docs/BaseResponseSelectListDto.md)
 - [BaseResponseSharedTableDto](docs/BaseResponseSharedTableDto.md)
 - [BaseResponseSpreadsheetInfoDto](docs/BaseResponseSpreadsheetInfoDto.md)
 - [BaseResponseString](docs/BaseResponseString.md)
 - [BaseResponseTableDto](docs/BaseResponseTableDto.md)
 - [BaseResponseTagDto](docs/BaseResponseTagDto.md)
 - [BaseResponseTokenDto](docs/BaseResponseTokenDto.md)
 - [BaseResponseValidateFilesDto](docs/BaseResponseValidateFilesDto.md)
 - [BaseResponseValidateTablesDto](docs/BaseResponseValidateTablesDto.md)
 - [Column](docs/Column.md)
 - [ColumnDto](docs/ColumnDto.md)
 - [ColumnInfoDto](docs/ColumnInfoDto.md)
 - [ConnectionDto](docs/ConnectionDto.md)
 - [ConnectionRunDto](docs/ConnectionRunDto.md)
 - [DatetimeDto](docs/DatetimeDto.md)
 - [DeleteWorkspace400Response](docs/DeleteWorkspace400Response.md)
 - [DescribeQueryColumnDto](docs/DescribeQueryColumnDto.md)
 - [DescribeQueryResponseDto](docs/DescribeQueryResponseDto.md)
 - [ExportFileDto](docs/ExportFileDto.md)
 - [ExportQueryResultDto](docs/ExportQueryResultDto.md)
 - [FileMetaDto](docs/FileMetaDto.md)
 - [FolderDto](docs/FolderDto.md)
 - [FolderableDto](docs/FolderableDto.md)
 - [GlobalParameterDto](docs/GlobalParameterDto.md)
 - [HierarchyMetadata](docs/HierarchyMetadata.md)
 - [ImportDto](docs/ImportDto.md)
 - [ImportErrorDto](docs/ImportErrorDto.md)
 - [ImportFromSpreadsheetDto](docs/ImportFromSpreadsheetDto.md)
 - [ImportInfoDto](docs/ImportInfoDto.md)
 - [MultiError](docs/MultiError.md)
 - [PagedResponseConnectionDto](docs/PagedResponseConnectionDto.md)
 - [PagedResponseFileMetaDto](docs/PagedResponseFileMetaDto.md)
 - [PagedResponseFolderDto](docs/PagedResponseFolderDto.md)
 - [PagedResponseFolderableDto](docs/PagedResponseFolderableDto.md)
 - [PagedResponseGlobalParameterDto](docs/PagedResponseGlobalParameterDto.md)
 - [PagedResponseImportErrorDto](docs/PagedResponseImportErrorDto.md)
 - [PagedResponsePivotViewDto](docs/PagedResponsePivotViewDto.md)
 - [PagedResponseQueryDto](docs/PagedResponseQueryDto.md)
 - [PagedResponseQueryResultDto](docs/PagedResponseQueryResultDto.md)
 - [PagedResponseSelectListDto](docs/PagedResponseSelectListDto.md)
 - [PagedResponseSharedTableDto](docs/PagedResponseSharedTableDto.md)
 - [PagedResponseTableDto](docs/PagedResponseTableDto.md)
 - [PagedResponseTagDto](docs/PagedResponseTagDto.md)
 - [PivotDefinitionDto](docs/PivotDefinitionDto.md)
 - [PivotViewDefinitionColumnDto](docs/PivotViewDefinitionColumnDto.md)
 - [PivotViewDefinitionFilterDto](docs/PivotViewDefinitionFilterDto.md)
 - [PivotViewDefinitionRowDto](docs/PivotViewDefinitionRowDto.md)
 - [PivotViewDefinitionValueDto](docs/PivotViewDefinitionValueDto.md)
 - [PivotViewDto](docs/PivotViewDto.md)
 - [QueryColumnDataDto](docs/QueryColumnDataDto.md)
 - [QueryDependencyDto](docs/QueryDependencyDto.md)
 - [QueryDto](docs/QueryDto.md)
 - [QueryParameterDto](docs/QueryParameterDto.md)
 - [QueryResultDto](docs/QueryResultDto.md)
 - [QueryTextDto](docs/QueryTextDto.md)
 - [RefreshBatchDto](docs/RefreshBatchDto.md)
 - [RefreshConnectionDto](docs/RefreshConnectionDto.md)
 - [SelectListDto](docs/SelectListDto.md)
 - [SharedTableDto](docs/SharedTableDto.md)
 - [SingleError](docs/SingleError.md)
 - [SpreadsheetInfoDto](docs/SpreadsheetInfoDto.md)
 - [StartValidateFilesDto](docs/StartValidateFilesDto.md)
 - [TableDto](docs/TableDto.md)
 - [TableSchema](docs/TableSchema.md)
 - [TagDto](docs/TagDto.md)
 - [TokenDto](docs/TokenDto.md)
 - [UniqueConstraintDto](docs/UniqueConstraintDto.md)
 - [ValidateFilesDto](docs/ValidateFilesDto.md)
 - [ValidateTablesDto](docs/ValidateTablesDto.md)


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


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

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: /iam/v1/oauth2/auth
- **Scopes**: N/A


## Author

platformsupport@workiva.com


