# qase-api-v2-client

> Qase TMS Javascript API V2 Client

Latest version **1.0.11** (published 2026-08-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install qase-api-v2-client
pnpm add qase-api-v2-client
yarn add qase-api-v2-client
bun add qase-api-v2-client
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2026-08-25 |
| First published | 2025-04-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 2 |
| Unpacked size | 133.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 56 |
| Author | Qase Team |
| Maintainers | qaseio |

## Links

- npm: https://www.npmjs.com/package/qase-api-v2-client
- Repository: https://github.com/qase-tms/qase-javascript
- Issues: https://github.com/qase-tms/qase-javascript/issues
- npm.io page: https://npm.io/package/qase-api-v2-client

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.18.1
- [axios-retry](https://npm.io/package/axios-retry.md) ^4.5.0

## Recent versions

- 1.0.11 (latest) — 2026-08-25
- 1.0.10-dev.1 (dev) — 2026-07-29
- 1.0.10 — 2026-07-31
- 1.0.10-dev.0 — 2026-07-27
- 1.0.9 — 2026-06-08
- 1.0.8 — 2026-06-05
- 1.0.7 — 2026-04-07
- 1.0.6 — 2026-03-26
- 1.0.5 — 2026-03-26
- 1.0.4 — 2025-11-21
- 1.0.3 — 2025-06-06
- 1.0.2 — 2025-05-16
- 1.0.1 — 2025-05-08
- 1.0.0 — 2025-04-16

## README

# qase

Qase TestOps API v2 Specification.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

* API version: 2.0.0
* Package version: 1.0.0
* Generator version: 7.4.0
* Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen

For more information, please visit [https://qase.io](https://qase.io)

## Requirements

* Node.js >= 14.0.0
* npm >= 6.0.0

## Installation & Usage

### npm install

```bash
npm install qase-api-v2-client
```

### yarn install

```bash
yarn add qase-api-v2-client
```

Then import the package:

```typescript
import { ResultsApi } from 'qase-api-v2-client';
```

## Getting Started

Please follow the installation procedure and then run the following:

```typescript
import { ResultsApi, Configuration } from 'qase-api-v2-client';

// Defining the host is optional and defaults to https://api.qase.io/v2
// See configuration.ts for a list of all supported configuration parameters.
const configuration = new Configuration({
    basePath: "https://api.qase.io/v2"
});

// 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.apiKey = process.env.API_KEY;

// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// configuration.apiKeyPrefix = 'Bearer';

// Create an instance of the API class
const qaseApi = new ResultsApi(configuration);

// Create test run result
try {
    const result = await qaseApi.results.createResultV2('MP', 1, {
        title: 'Test Result',
        execution: {
            status: 'passed',
            duration: 1000
        },
        testops_id: 1,
        steps: [
            {
                position: 1,
                status: 'passed',
                comment: 'Step completed successfully'
            }
        ]
    });
    console.log(result);
} catch (error) {
    console.error('Error creating result:', error);
}
```

## Documentation for API Endpoints

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

| Class | Method | HTTP request | Description |
|-------|--------|--------------|-------------|
| *CustomFieldsApi* | [**getCustomFieldV2**](docs/CustomFieldsApi.md#getcustomfieldv2) | **GET** /custom_field/{id} | Get Custom Field |
| *CustomFieldsApi* | [**getCustomFieldsV2**](docs/CustomFieldsApi.md#getcustomfieldsv2) | **GET** /custom_field | Get all Custom Fields |
| *ResultsApi* | [**createResultV2**](docs/ResultsApi.md#createresultv2) | **POST** /{project_code}/run/{run_id}/result | Create test run result |
| *ResultsApi* | [**createResultsV2**](docs/ResultsApi.md#createresultsv2) | **POST** /{project_code}/run/{run_id}/results | Bulk create test run result |

## Documentation For Models

* [CreateResultsRequestV2](docs/CreateResultsRequestV2.md)
* [CustomField](docs/CustomField.md)
* [CustomFieldListResponse](docs/CustomFieldListResponse.md)
* [CustomFieldOption](docs/CustomFieldOption.md)
* [CustomFieldResponse](docs/CustomFieldResponse.md)
* [RelationSuite](docs/RelationSuite.md)
* [RelationSuiteItem](docs/RelationSuiteItem.md)
* [ResultCreate](docs/ResultCreate.md)
* [ResultCreateFields](docs/ResultCreateFields.md)
* [ResultExecution](docs/ResultExecution.md)
* [ResultRelations](docs/ResultRelations.md)
* [ResultStep](docs/ResultStep.md)
* [ResultStepData](docs/ResultStepData.md)
* [ResultStepExecution](docs/ResultStepExecution.md)
* [ResultStepStatus](docs/ResultStepStatus.md)
* [ResultStepsType](docs/ResultStepsType.md)

## Documentation For Authorization

### TokenAuth

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

## Author

<support@qase.io>

---
_Source: https://npm.io/package/qase-api-v2-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._