New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

testkube-sdk

Package Overview
Dependencies
Maintainers
2
Versions
47
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

testkube-sdk

<!-- Start SDK Installation --> ## SDK Installation

  • 2.1.1
  • Source
  • npm
  • Socket score
Version published
Maintainers
2
Created
Source

testkube-sdk

SDK Installation

NPM

npm add testkube-sdk

Yarn

yarn add testkube-sdk

SDK Example Usage

Example

import { TestkubeSDK } from "testkube-sdk";

(async () => {
    const sdk = new TestkubeSDK();

    const res = await sdk.api.abortExecution({
        executionID: "string",
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Available Resources and Operations

api

tests

executions

artifacts

logs

executor

keymap

labels

repository

testSources

testSuites

testTriggers

webhook

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a next method that can be called to pull down the next group of results. If the return value of next is null, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error ObjectStatus CodeContent Type
errors.SDKError400-600/

Example

import { TestkubeSDK } from "testkube-sdk";

(async () => {
    const sdk = new TestkubeSDK();

    let res;
    try {
        res = await sdk.api.abortExecution({
            executionID: "string",
            id: "<ID>",
        });
    } catch (e) {}

    if (res.statusCode == 200) {
        // handle response
    }
})();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#ServerVariables
0https://demo.testkube.io/results/v1None
Example
import { TestkubeSDK } from "testkube-sdk";

(async () => {
    const sdk = new TestkubeSDK({
        serverIdx: 0,
    });

    const res = await sdk.api.abortExecution({
        executionID: "string",
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

import { TestkubeSDK } from "testkube-sdk";

(async () => {
    const sdk = new TestkubeSDK({
        serverURL: "https://demo.testkube.io/results/v1",
    });

    const res = await sdk.api.abortExecution({
        executionID: "string",
        id: "<ID>",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Custom HTTP Client

The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

from testkube-sdk import TestkubeSDK;
import axios;

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new TestkubeSDK({defaultClient: httpClient});

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

FAQs

Package last updated on 10 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Security News

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.

By Sarah Gooding  -  Feb 07, 2025
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc