@or-sdk/transcripts

OneReach SDK client for Transcripts.

When to use

• Use this package when integrating with the Transcripts 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/transcripts

Usage

import { Transcripts } from '@or-sdk/transcripts'

// with direct api url
const transcripts = new Transcripts({
  token: 'my-account-token-string',
  transcriptsApiUrl: 'http://example.transcripts/endpoint'
});

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

Configuration

• Prefer transcriptsApiUrl 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 | |---|---| | createTranscript(...) | See the exported TypeScript signature for parameters and result. | | findOneTranscript(...) | See the exported TypeScript signature for parameters and result. | | findAllTranscripts(...) | See the exported TypeScript signature for parameters and result. | | getTranscription(...) | See the exported TypeScript signature for parameters and result. | | updateTranscription(...) | See the exported TypeScript signature for parameters and result. | | getClientPhones(...) | See the exported TypeScript signature for parameters and result. | | getServicePhones(...) | See the exported TypeScript signature for parameters and result. | | generateData(...) | See the exported TypeScript signature for parameters and result. |

More detail

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