Skip to content

TypeDoc API Reference

The complete SDK API reference is generated using TypeDoc from the TypeScript source code.

Open Full API Reference

Category Description
Classes SDK client classes with full method documentation
Interfaces TypeScript interfaces for configuration and data types
Types Type aliases and union types
Functions Utility functions

Browse the Full API Reference for complete details.

Main Classes

ContioPartnerSDK

The primary SDK client for interacting with the Contio Partner API.

import { ContioPartnerSDK } from '@contio/partner-sdk';

const sdk = new ContioPartnerSDK({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  environment: 'production'
});

Other Key Classes

Class Description
OAuthClient Handle OAuth 2.0 authorization flows
ApiKeyClient API key-based authentication
PartnerUserClient User-level API operations
PartnerAdminClient Admin-level API operations
WebhookVerifier Verify webhook signatures