@or-sdk/adapters

OneReach SDK client for Adapters.

When to use

• Use this package when integrating with the Adapters capability on the OneReach platform.
• Use its typed client and exported models instead of hand-writing requests to that service.

When not to use

• Do not use it for a different platform capability; choose the dedicated @or-sdk/* package instead.
• Do not use it for generic third-party HTTP calls.

Installation

$ npm i @or-sdk/adapters

Usage

import { Adapters } from '@or-sdk/adapters'

// with direct api url
const adapters = new Adapters({
  token: 'my-account-token-string',
  eventManagerUrl: 'http://example.event-manager/endpoint',
  accountId: 'account-id-string'
});

// with service discovery(slower)
const adapters = new Adapters({
  token: 'my-account-token-string',
  discoveryUrl: 'http://example.discovery/endpoint'
});

Configuration

• Prefer eventManagerUrl when the service URL is known; it avoids a discovery request.
• Use discoveryUrl only when the service URL is not available.
• Provide token as a bearer-token string or getter where supported.

Common pitfalls

• Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
• Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.

Method map

| Method | Purpose | |---|---| | getGatewayUrl(...) | See the exported TypeScript signature for parameters and result. |

More detail

Full signatures and exported types are available in src/ and dist/types/.

Additional API reference

Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.

Adapters

| Method | Returns | Purpose | |---|---|---| | makeRequest(params: CalApiParams) | Promise<T> | See the exported TypeScript signature for behavior and constraints. |