ConductorOne TypeScript SDK

Common errors

• Cannot find module 'conductorone-sdk-typescript' or its corresponding type declarations.

  cause The package is not installed, or the import path is incorrect, or TypeScript cannot find declaration files.
  fix Install the package: `npm install conductorone-sdk-typescript`. Verify the import statement: `import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";`.

• TypeError: Cannot read properties of undefined (reading 'createMonitor') at ConductoroneSDKTypescript.accessConflict

  cause The SDK client instance (`conductoroneSDKTypescript`) was not properly initialized, or the `security` configuration was invalid, leading to a non-functional client object.
  fix Ensure the `ConductoroneSDKTypescript` class is correctly instantiated with all required `security` parameters, e.g., `new ConductoroneSDKTypescript({ security: { bearerAuth: 'YOUR_TOKEN' } })`.

• Error: Request failed with status code 401: Unauthorized

  cause The provided authentication credentials (Bearer token or OAuth token) are either missing, expired, or invalid.
  fix Verify that the `bearerAuth` or `oauth` token supplied during SDK initialization is correct, active, and has the necessary permissions for the API call.

Warnings

• gotcha A peer dependency on `react` is declared, which might be unexpected for a backend API client. If you encounter issues in a React context or bundling errors, ensure `react` is installed in your project.
  Fix: If working in a React environment, add `react` to your project dependencies: `npm install react` or `yarn add react`.
• breaking As an SDK generated by Speakeasy CLI, minor versions (e.g., from 1.0.x to 1.1.x) may introduce breaking changes to API models, request/response structures, or method signatures if the underlying ConductorOne API contract evolves. Always review changelogs.
  Fix: Consult the official changelog for `conductorone-sdk-typescript` and the ConductorOne API documentation for specific version migration guides before upgrading non-patch versions.
• gotcha Handling of authentication (Bearer Token or OAuth2) requires providing credentials during SDK initialization. Failure to do so will result in unauthorized API calls (e.g., 401 status codes).
  Fix: Ensure the `security` object with a valid `bearerAuth` token or `oauth` token is passed to the `ConductoroneSDKTypescript` constructor during initialization.

Install

• npm install conductorone-sdk-typescript npm
• yarn add conductorone-sdk-typescript yarn
• pnpm add conductorone-sdk-typescript pnpm

Imports

• ConductoroneSDKTypescript
  wrong:

  const ConductoroneSDKTypescript = require("conductorone-sdk-typescript");

  correct:

  import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

  The main SDK client class. Supports both CommonJS and ES Modules environments. For CommonJS, use `const { ConductoroneSDKTypescript } = require('conductorone-sdk-typescript');`.
• operations (namespace)

  import * as operations from "conductorone-sdk-typescript/models/operations";

  Access specific operation request and response types, e.g., `operations.CreateMonitorRequest` or `operations.CreateMonitorResponse`. The exact path might vary slightly depending on the SDK generation.
• shared (namespace)

  import * as shared from "conductorone-sdk-typescript/models/shared";

  Import shared data models and types used across multiple API operations, e.g., `shared.App` or `shared.Pagination`.

Quickstart

This example initializes the ConductorOne SDK client with authentication and then makes an API call to create a monitor for access conflicts, logging the result.

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: process.env.CONDUCTORONE_BEARER_TOKEN ?? "",
    oauth: process.env.CONDUCTORONE_OAUTH_TOKEN ?? "",
  },
});

async function run() {
  try {
    const result = await conductoroneSDKTypescript.accessConflict.createMonitor();
    console.log(result);
  } catch (error) {
    console.error("Error making API call:", error);
  }
}

run();