@novr/bitrise-api

This is a client library generated by OpenAPI Generator for interacting with the Bitrise API. It provides a convenient way to access Bitrise API endpoints from your application.

Installation

npm install @novr/bitrise-api

Usage

Configuration

Create a Configuration instance and pass it to the generated API classes (for example BuildsApi). Each API class extends BaseAPI and uses that configuration for base URL, fetch, and authentication.

import { Configuration, BuildsApi } from '@novr/bitrise-api'

const config = new Configuration({
  basePath: 'https://api.bitrise.io/v0.1',
  apiKey: 'YOUR_PERSONAL_ACCESS_TOKEN',
})

The Bitrise OpenAPI spec uses the Authorization header for the personal access token; the generated client wires apiKey to that header.

Use the API

import { BuildsApi } from '@novr/bitrise-api'

const buildsApi = new BuildsApi(config)

try {
  const result = await buildsApi.buildListAll({})
  console.log(result)
} catch (error) {
  console.error('buildListAll failed:', error)
}

typescript-fetch methods such as buildListAll return the parsed model (Promise<V0BuildListAllResponseModel> here), not an Axios-style { data } wrapper. Use *Raw variants if you need the Response object.

Examples

You can find usage example and more in-depth documentation in the example directory.

License

This project is licensed under the MIT License - see the LICENSE file for details.