qase-api-client 2.0.3
Qase TestOps API V1 client for Python
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Qase.io TestOps API

# qase-api-client

Qase TestOps API v1 Specification.

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

- API version: 1.0.0
- Generator version: 7.15.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://qase.io](https://qase.io)

## 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 qase-api-client
```

(you may need to run `pip` with root permission: `sudo pip install qase-api-client`)

Then import the package:

```python
import qase.api_client_v1
```

### 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 qase.api_client_v1
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import qase.api_client_v1
from qase.api_client_v1.rest import ApiException
from pprint import pprint
import certifi

# Defining the host is optional and defaults to https://api.qase.io/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = qase.api_client_v1.Configuration(
    host = "https://api.qase.io/v1"
)

configuration.ssl_ca_cert = certifi.where()

# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
with qase.api_client_v1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qase.api_client_v1.AttachmentsApi(api_client)
    hash = 'hash_example' # str | Hash.

    try:
        # Remove attachment by Hash
        api_response = api_instance.delete_attachment(hash)
        print("The response of AttachmentsApi->delete_attachment:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AttachmentsApi->delete_attachment: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *<https://api.qase.io/v1>*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AttachmentsApi* | [**delete_attachment**](docs/AttachmentsApi.md#delete_attachment) | **DELETE** /attachment/{hash} | Remove attachment by Hash
*AttachmentsApi* | [**get_attachment**](docs/AttachmentsApi.md#get_attachment) | **GET** /attachment/{hash} | Get attachment by Hash
*AttachmentsApi* | [**get_attachments**](docs/AttachmentsApi.md#get_attachments) | **GET** /attachment | Get all attachments
*AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /attachment/{code} | Upload attachment
*AuthorsApi* | [**get_author**](docs/AuthorsApi.md#get_author) | **GET** /author/{id} | Get a specific author
*AuthorsApi* | [**get_authors**](docs/AuthorsApi.md#get_authors) | **GET** /author | Get all authors
*CasesApi* | [**bulk**](docs/CasesApi.md#bulk) | **POST** /case/{code}/bulk | Create test cases in bulk
*CasesApi* | [**case_attach_external_issue**](docs/CasesApi.md#case_attach_external_issue) | **POST** /case/{code}/external-issue/attach | Attach the external issues to the test cases
*CasesApi* | [**case_detach_external_issue**](docs/CasesApi.md#case_detach_external_issue) | **POST** /case/{code}/external-issue/detach | Detach the external issues from the test cases
*CasesApi* | [**create_case**](docs/CasesApi.md#create_case) | **POST** /case/{code} | Create a new test case
*CasesApi* | [**delete_case**](docs/CasesApi.md#delete_case) | **DELETE** /case/{code}/{id} | Delete test case
*CasesApi* | [**get_case**](docs/CasesApi.md#get_case) | **GET** /case/{code}/{id} | Get a specific test case
*CasesApi* | [**get_cases**](docs/CasesApi.md#get_cases) | **GET** /case/{code} | Get all test cases
*CasesApi* | [**update_case**](docs/CasesApi.md#update_case) | **PATCH** /case/{code}/{id} | Update test case
*ConfigurationsApi* | [**create_configuration**](docs/ConfigurationsApi.md#create_configuration) | **POST** /configuration/{code} | Create a new configuration in a particular group.
*ConfigurationsApi* | [**create_configuration_group**](docs/ConfigurationsApi.md#create_configuration_group) | **POST** /configuration/{code}/group | Create a new configuration group.
*ConfigurationsApi* | [**get_configurations**](docs/ConfigurationsApi.md#get_configurations) | **GET** /configuration/{code} | Get all configuration groups with configurations.
*CustomFieldsApi* | [**create_custom_field**](docs/CustomFieldsApi.md#create_custom_field) | **POST** /custom_field | Create new Custom Field
*CustomFieldsApi* | [**delete_custom_field**](docs/CustomFieldsApi.md#delete_custom_field) | **DELETE** /custom_field/{id} | Delete Custom Field by id
*CustomFieldsApi* | [**get_custom_field**](docs/CustomFieldsApi.md#get_custom_field) | **GET** /custom_field/{id} | Get Custom Field by id
*CustomFieldsApi* | [**get_custom_fields**](docs/CustomFieldsApi.md#get_custom_fields) | **GET** /custom_field | Get all Custom Fields
*CustomFieldsApi* | [**update_custom_field**](docs/CustomFieldsApi.md#update_custom_field) | **PATCH** /custom_field/{id} | Update Custom Field by id
*DefectsApi* | [**create_defect**](docs/DefectsApi.md#create_defect) | **POST** /defect/{code} | Create a new defect
*DefectsApi* | [**delete_defect**](docs/DefectsApi.md#delete_defect) | **DELETE** /defect/{code}/{id} | Delete defect
*DefectsApi* | [**get_defect**](docs/DefectsApi.md#get_defect) | **GET** /defect/{code}/{id} | Get a specific defect
*DefectsApi* | [**get_defects**](docs/DefectsApi.md#get_defects) | **GET** /defect/{code} | Get all defects
*DefectsApi* | [**resolve_defect**](docs/DefectsApi.md#resolve_defect) | **PATCH** /defect/{code}/resolve/{id} | Resolve a specific defect
*DefectsApi* | [**update_defect**](docs/DefectsApi.md#update_defect) | **PATCH** /defect/{code}/{id} | Update defect
*DefectsApi* | [**update_defect_status**](docs/DefectsApi.md#update_defect_status) | **PATCH** /defect/{code}/status/{id} | Update a specific defect status
*EnvironmentsApi* | [**create_environment**](docs/EnvironmentsApi.md#create_environment) | **POST** /environment/{code} | Create a new environment
*EnvironmentsApi* | [**delete_environment**](docs/EnvironmentsApi.md#delete_environment) | **DELETE** /environment/{code}/{id} | Delete environment
*EnvironmentsApi* | [**get_environment**](docs/EnvironmentsApi.md#get_environment) | **GET** /environment/{code}/{id} | Get a specific environment
*EnvironmentsApi* | [**get_environments**](docs/EnvironmentsApi.md#get_environments) | **GET** /environment/{code} | Get all environments
*EnvironmentsApi* | [**update_environment**](docs/EnvironmentsApi.md#update_environment) | **PATCH** /environment/{code}/{id} | Update environment
*MilestonesApi* | [**create_milestone**](docs/MilestonesApi.md#create_milestone) | **POST** /milestone/{code} | Create a new milestone
*MilestonesApi* | [**delete_milestone**](docs/MilestonesApi.md#delete_milestone) | **DELETE** /milestone/{code}/{id} | Delete milestone
*MilestonesApi* | [**get_milestone**](docs/MilestonesApi.md#get_milestone) | **GET** /milestone/{code}/{id} | Get a specific milestone
*MilestonesApi* | [**get_milestones**](docs/MilestonesApi.md#get_milestones) | **GET** /milestone/{code} | Get all milestones
*MilestonesApi* | [**update_milestone**](docs/MilestonesApi.md#update_milestone) | **PATCH** /milestone/{code}/{id} | Update milestone
*PlansApi* | [**create_plan**](docs/PlansApi.md#create_plan) | **POST** /plan/{code} | Create a new plan
*PlansApi* | [**delete_plan**](docs/PlansApi.md#delete_plan) | **DELETE** /plan/{code}/{id} | Delete plan
*PlansApi* | [**get_plan**](docs/PlansApi.md#get_plan) | **GET** /plan/{code}/{id} | Get a specific plan
*PlansApi* | [**get_plans**](docs/PlansApi.md#get_plans) | **GET** /plan/{code} | Get all plans
*PlansApi* | [**update_plan**](docs/PlansApi.md#update_plan) | **PATCH** /plan/{code}/{id} | Update plan
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /project | Create new project
*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /project/{code} | Delete Project by code
*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /project/{code} | Get Project by code
*ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /project | Get All Projects
*ProjectsApi* | [**grant_access_to_project**](docs/ProjectsApi.md#grant_access_to_project) | **POST** /project/{code}/access | Grant access to project by code
*ProjectsApi* | [**revoke_access_to_project**](docs/ProjectsApi.md#revoke_access_to_project) | **DELETE** /project/{code}/access | Revoke access to project by code
*ResultsApi* | [**create_result**](docs/ResultsApi.md#create_result) | **POST** /result/{code}/{id} | Create test run result
*ResultsApi* | [**create_result_bulk**](docs/ResultsApi.md#create_result_bulk) | **POST** /result/{code}/{id}/bulk | Bulk create test run result
*ResultsApi* | [**delete_result**](docs/ResultsApi.md#delete_result) | **DELETE** /result/{code}/{id}/{hash} | Delete test run result
*ResultsApi* | [**get_result**](docs/ResultsApi.md#get_result) | **GET** /result/{code}/{hash} | Get test run result by code
*ResultsApi* | [**get_results**](docs/ResultsApi.md#get_results) | **GET** /result/{code} | Get all test run results
*ResultsApi* | [**update_result**](docs/ResultsApi.md#update_result) | **PATCH** /result/{code}/{id}/{hash} | Update test run result
*RunsApi* | [**complete_run**](docs/RunsApi.md#complete_run) | **POST** /run/{code}/{id}/complete | Complete a specific run
*RunsApi* | [**create_run**](docs/RunsApi.md#create_run) | **POST** /run/{code} | Create a new run
*RunsApi* | [**delete_run**](docs/RunsApi.md#delete_run) | **DELETE** /run/{code}/{id} | Delete run
*RunsApi* | [**get_run**](docs/RunsApi.md#get_run) | **GET** /run/{code}/{id} | Get a specific run
*RunsApi* | [**get_runs**](docs/RunsApi.md#get_runs) | **GET** /run/{code} | Get all runs
*RunsApi* | [**update_run_publicity**](docs/RunsApi.md#update_run_publicity) | **PATCH** /run/{code}/{id}/public | Update publicity of a specific run
*SearchApi* | [**search**](docs/SearchApi.md#search) | **GET** /search | Search entities by Qase Query Language (QQL)
*SharedStepsApi* | [**create_shared_step**](docs/SharedStepsApi.md#create_shared_step) | **POST** /shared_step/{code} | Create a new shared step
*SharedStepsApi* | [**delete_shared_step**](docs/SharedStepsApi.md#delete_shared_step) | **DELETE** /shared_step/{code}/{hash} | Delete shared step
*SharedStepsApi* | [**get_shared_step**](docs/SharedStepsApi.md#get_shared_step) | **GET** /shared_step/{code}/{hash} | Get a specific shared step
*SharedStepsApi* | [**get_shared_steps**](docs/SharedStepsApi.md#get_shared_steps) | **GET** /shared_step/{code} | Get all shared steps
*SharedStepsApi* | [**update_shared_step**](docs/SharedStepsApi.md#update_shared_step) | **PATCH** /shared_step/{code}/{hash} | Update shared step
*SuitesApi* | [**create_suite**](docs/SuitesApi.md#create_suite) | **POST** /suite/{code} | Create a new test suite
*SuitesApi* | [**delete_suite**](docs/SuitesApi.md#delete_suite) | **DELETE** /suite/{code}/{id} | Delete test suite
*SuitesApi* | [**get_suite**](docs/SuitesApi.md#get_suite) | **GET** /suite/{code}/{id} | Get a specific test suite
*SuitesApi* | [**get_suites**](docs/SuitesApi.md#get_suites) | **GET** /suite/{code} | Get all test suites
*SuitesApi* | [**update_suite**](docs/SuitesApi.md#update_suite) | **PATCH** /suite/{code}/{id} | Update test suite
*SystemFieldsApi* | [**get_system_fields**](docs/SystemFieldsApi.md#get_system_fields) | **GET** /system_field | Get all System Fields

## Documentation For Models

- [Attachment](docs/Attachment.md)
- [AttachmentGet](docs/AttachmentGet.md)
- [AttachmentHash](docs/AttachmentHash.md)
- [AttachmentListResponse](docs/AttachmentListResponse.md)
- [AttachmentListResponseAllOfResult](docs/AttachmentListResponseAllOfResult.md)
- [AttachmentResponse](docs/AttachmentResponse.md)
- [AttachmentUploadsResponse](docs/AttachmentUploadsResponse.md)
- [Attachmentupload](docs/Attachmentupload.md)
- [Author](docs/Author.md)
- [AuthorListResponse](docs/AuthorListResponse.md)
- [AuthorListResponseAllOfResult](docs/AuthorListResponseAllOfResult.md)
- [AuthorResponse](docs/AuthorResponse.md)
- [BaseResponse](docs/BaseResponse.md)
- [Bulk200Response](docs/Bulk200Response.md)
- [Bulk200ResponseAllOfResult](docs/Bulk200ResponseAllOfResult.md)
- [Configuration](docs/Configuration.md)
- [ConfigurationCreate](docs/ConfigurationCreate.md)
- [ConfigurationGroup](docs/ConfigurationGroup.md)
- [ConfigurationGroupCreate](docs/ConfigurationGroupCreate.md)
- [ConfigurationListResponse](docs/ConfigurationListResponse.md)
- [ConfigurationListResponseAllOfResult](docs/ConfigurationListResponseAllOfResult.md)
- [CustomField](docs/CustomField.md)
- [CustomFieldCreate](docs/CustomFieldCreate.md)
- [CustomFieldCreateValueInner](docs/CustomFieldCreateValueInner.md)
- [CustomFieldListResponse](docs/CustomFieldListResponse.md)
- [CustomFieldResponse](docs/CustomFieldResponse.md)
- [CustomFieldUpdate](docs/CustomFieldUpdate.md)
- [CustomFieldValue](docs/CustomFieldValue.md)
- [CustomFieldsResponse](docs/CustomFieldsResponse.md)
- [CustomFieldsResponseAllOfResult](docs/CustomFieldsResponseAllOfResult.md)
- [Defect](docs/Defect.md)
- [DefectCreate](docs/DefectCreate.md)
- [DefectListResponse](docs/DefectListResponse.md)
- [DefectListResponseAllOfResult](docs/DefectListResponseAllOfResult.md)
- [DefectQuery](docs/DefectQuery.md)
- [DefectResponse](docs/DefectResponse.md)
- [DefectStatus](docs/DefectStatus.md)
- [DefectUpdate](docs/DefectUpdate.md)
- [Environment](docs/Environment.md)
- [EnvironmentCreate](docs/EnvironmentCreate.md)
- [EnvironmentListResponse](docs/EnvironmentListResponse.md)
- [EnvironmentListResponseAllOfResult](docs/EnvironmentListResponseAllOfResult.md)
- [EnvironmentResponse](docs/EnvironmentResponse.md)
- [EnvironmentUpdate](docs/EnvironmentUpdate.md)
- [ExternalIssue](docs/ExternalIssue.md)
- [ExternalIssueIssuesInner](docs/ExternalIssueIssuesInner.md)
- [HashResponse](docs/HashResponse.md)
- [HashResponseAllOfResult](docs/HashResponseAllOfResult.md)
- [IdResponse](docs/IdResponse.md)
- [IdResponseAllOfResult](docs/IdResponseAllOfResult.md)
- [Milestone](docs/Milestone.md)
- [MilestoneCreate](docs/MilestoneCreate.md)
- [MilestoneListResponse](docs/MilestoneListResponse.md)
- [MilestoneListResponseAllOfResult](docs/MilestoneListResponseAllOfResult.md)
- [MilestoneResponse](docs/MilestoneResponse.md)
- [MilestoneUpdate](docs/MilestoneUpdate.md)
- [Plan](docs/Plan.md)
- [PlanCreate](docs/PlanCreate.md)
- [PlanDetailed](docs/PlanDetailed.md)
- [PlanDetailedAllOfCases](docs/PlanDetailedAllOfCases.md)
- [PlanListResponse](docs/PlanListResponse.md)
- [PlanListResponseAllOfResult](docs/PlanListResponseAllOfResult.md)
- [PlanQuery](docs/PlanQuery.md)
- [PlanResponse](docs/PlanResponse.md)
- [PlanUpdate](docs/PlanUpdate.md)
- [Project](docs/Project.md)
- [ProjectAccess](docs/ProjectAccess.md)
- [ProjectCodeResponse](docs/ProjectCodeResponse.md)
- [ProjectCodeResponseAllOfResult](docs/ProjectCodeResponseAllOfResult.md)
- [ProjectCounts](docs/ProjectCounts.md)
- [ProjectCountsDefects](docs/ProjectCountsDefects.md)
- [ProjectCountsRuns](docs/ProjectCountsRuns.md)
- [ProjectCreate](docs/ProjectCreate.md)
- [ProjectListResponse](docs/ProjectListResponse.md)
- [ProjectListResponseAllOfResult](docs/ProjectListResponseAllOfResult.md)
- [ProjectResponse](docs/ProjectResponse.md)
- [QqlDefect](docs/QqlDefect.md)
- [QqlPlan](docs/QqlPlan.md)
- [QqlTestCase](docs/QqlTestCase.md)
- [Requirement](docs/Requirement.md)
- [Response](docs/Response.md)
- [Result](docs/Result.md)
- [ResultCreate](docs/ResultCreate.md)
- [ResultCreateBulk](docs/ResultCreateBulk.md)
- [ResultCreateCase](docs/ResultCreateCase.md)
- [ResultCreateResponse](docs/ResultCreateResponse.md)
- [ResultCreateResponseAllOfResult](docs/ResultCreateResponseAllOfResult.md)
- [ResultListResponse](docs/ResultListResponse.md)
- [ResultListResponseAllOfResult](docs/ResultListResponseAllOfResult.md)
- [ResultResponse](docs/ResultResponse.md)
- [ResultUpdate](docs/ResultUpdate.md)
- [ResultcreateBulk](docs/ResultcreateBulk.md)
- [Run](docs/Run.md)
- [RunCreate](docs/RunCreate.md)
- [RunEnvironment](docs/RunEnvironment.md)
- [RunListResponse](docs/RunListResponse.md)
- [RunListResponseAllOfResult](docs/RunListResponseAllOfResult.md)
- [RunMilestone](docs/RunMilestone.md)
- [RunPublic](docs/RunPublic.md)
- [RunPublicResponse](docs/RunPublicResponse.md)
- [RunPublicResponseAllOfResult](docs/RunPublicResponseAllOfResult.md)
- [RunResponse](docs/RunResponse.md)
- [RunStats](docs/RunStats.md)
- [SearchResponse](docs/SearchResponse.md)
- [SearchResponseAllOfResult](docs/SearchResponseAllOfResult.md)
- [SearchResponseAllOfResultEntities](docs/SearchResponseAllOfResultEntities.md)
- [SharedStep](docs/SharedStep.md)
- [SharedStepContent](docs/SharedStepContent.md)
- [SharedStepContentCreate](docs/SharedStepContentCreate.md)
- [SharedStepCreate](docs/SharedStepCreate.md)
- [SharedStepListResponse](docs/SharedStepListResponse.md)
- [SharedStepListResponseAllOfResult](docs/SharedStepListResponseAllOfResult.md)
- [SharedStepResponse](docs/SharedStepResponse.md)
- [SharedStepUpdate](docs/SharedStepUpdate.md)
- [Suite](docs/Suite.md)
- [SuiteCreate](docs/SuiteCreate.md)
- [SuiteDelete](docs/SuiteDelete.md)
- [SuiteListResponse](docs/SuiteListResponse.md)
- [SuiteListResponseAllOfResult](docs/SuiteListResponseAllOfResult.md)
- [SuiteResponse](docs/SuiteResponse.md)
- [SuiteUpdate](docs/SuiteUpdate.md)
- [SystemField](docs/SystemField.md)
- [SystemFieldListResponse](docs/SystemFieldListResponse.md)
- [SystemFieldOption](docs/SystemFieldOption.md)
- [TagValue](docs/TagValue.md)
- [TestCase](docs/TestCase.md)
- [TestCaseCreate](docs/TestCaseCreate.md)
- [TestCaseExternalIssues](docs/TestCaseExternalIssues.md)
- [TestCaseExternalIssuesLinksInner](docs/TestCaseExternalIssuesLinksInner.md)
- [TestCaseListResponse](docs/TestCaseListResponse.md)
- [TestCaseListResponseAllOfResult](docs/TestCaseListResponseAllOfResult.md)
- [TestCaseParams](docs/TestCaseParams.md)
- [TestCaseQuery](docs/TestCaseQuery.md)
- [TestCaseResponse](docs/TestCaseResponse.md)
- [TestCaseUpdate](docs/TestCaseUpdate.md)
- [TestCasebulk](docs/TestCasebulk.md)
- [TestCasebulkCasesInner](docs/TestCasebulkCasesInner.md)
- [TestCaseexternalIssues](docs/TestCaseexternalIssues.md)
- [TestStep](docs/TestStep.md)
- [TestStepCreate](docs/TestStepCreate.md)
- [TestStepResult](docs/TestStepResult.md)
- [TestStepResultCreate](docs/TestStepResultCreate.md)

<a id="documentation-for-authorization"></a>

## Documentation For Authorization

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

### TokenAuth

- **Type**: API key
- **API key parameter name**: Token
- **Location**: HTTP header

## Author

<support@qase.io>