Skip to content

Latest commit

 

History

History
executable file
·
372 lines (272 loc) · 14.7 KB

README.md

File metadata and controls

executable file
·
372 lines (272 loc) · 14.7 KB
Raw

CircleCI API Node SDK

The CircleCI API Node SDK is a NPM library for accessing the resources that make up the CircleCI API V2.

SDK Installation

NPM

npm add circleci-v2-sdk

Yarn

yarn add circleci-v2-sdk

SDK Example Usage

Example

import { Circleci } from "circleci-v2-sdk";

async function run() {
    const sdk = new Circleci({
        security: {
            apiKeyHeader: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.context.addEnvironmentVariableToContext({
        requestBody: {
            value: "some-secret-value",
        },
        contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96",
        envVarName: "POSTGRES_USER",
    });

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

run();

Available Resources and Operations

context

insights

user

oidcTokenManagement

usage

policyManagement

pipeline

project

job

schedule

webhook

workflow

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 Object Status Code Content Type
errors.SDKError 4xx-5xx /

Example

import { Circleci } from "circleci-v2-sdk";

async function run() {
    const sdk = new Circleci({
        security: {
            apiKeyHeader: "<YOUR_API_KEY_HERE>",
        },
    });

    let res;
    try {
        res = await sdk.context.addEnvironmentVariableToContext({
            requestBody: {
                value: "some-secret-value",
            },
            contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96",
            envVarName: "POSTGRES_USER",
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

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

run();

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:

# Server Variables
0 https://circleci.com/api/v2 None

Example

import { Circleci } from "circleci-v2-sdk";

async function run() {
    const sdk = new Circleci({
        serverIdx: 0,
        security: {
            apiKeyHeader: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.context.addEnvironmentVariableToContext({
        requestBody: {
            value: "some-secret-value",
        },
        contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96",
        envVarName: "POSTGRES_USER",
    });

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

run();

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 { Circleci } from "circleci-v2-sdk";

async function run() {
    const sdk = new Circleci({
        serverURL: "https://circleci.com/api/v2",
        security: {
            apiKeyHeader: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.context.addEnvironmentVariableToContext({
        requestBody: {
            value: "some-secret-value",
        },
        contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96",
        envVarName: "POSTGRES_USER",
    });

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

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios 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:

import { circleci-v2-sdk } from "Circleci";
import axios from "axios";

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

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

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme
apiKeyHeader apiKey API key
apiKeyQuery apiKey API key
basicAuth http HTTP Basic

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Circleci } from "circleci-v2-sdk";

async function run() {
    const sdk = new Circleci({
        security: {
            apiKeyHeader: "<YOUR_API_KEY_HERE>",
        },
    });

    const res = await sdk.context.addEnvironmentVariableToContext({
        requestBody: {
            value: "some-secret-value",
        },
        contextId: "0407a4cd-7d9d-4359-a2ad-0a7c67c0ba96",
        envVarName: "POSTGRES_USER",
    });

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

run();

SDK Generated by Speakeasy