1.9.0 • Published 2 weeks ago

@or-sdk/bots

Licence

Apache-2.0

Version

1.9.0

Deps

Size

77 kB

Vulns

Weekly

Summary Dependency Versions

`@or-sdk/bots`

OneReach SDK client for Bots.

When to use

Use this package when integrating with the Bots 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/bots

Usage

import { Bots } from '@or-sdk/bots'

// with direct api url
const bots = new Bots({
  token: 'my-account-token-string',
  dataHubSvcUrl: 'http://example.data-hub-svc/endpoint'
});

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

Configuration

Prefer dataHubSvcUrl 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
`listBots(...)`	See the exported TypeScript signature for parameters and result.
`getBot(...)`	See the exported TypeScript signature for parameters and result.
`saveBot(...)`	See the exported TypeScript signature for parameters and result.
`deleteBot(...)`	See the exported TypeScript signature for parameters and result.
`recoverBot(...)`	See the exported TypeScript signature for parameters and result.
`downloadTemplate(...)`	See the exported TypeScript signature for parameters and result.
`addTags(...)`	See the exported TypeScript signature for parameters and result.
`removeTags(...)`	See the exported TypeScript signature for parameters and result.
`uploaderBotImage(...)`	See the exported TypeScript signature for parameters and result.
`resolve(...)`	See the exported TypeScript signature for parameters and result.
`listBotCategories(...)`	See the exported TypeScript signature for parameters and result.

More detail

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