@or-sdk/deployments

OneReach SDK client for Deployments.

When to use

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

Usage

import { Deployments } from '@or-sdk/deployments'

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

// with service discovery(slower)
const deployments = new Deployments({
  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 | |---|---| | listDeployments(...) | See the exported TypeScript signature for parameters and result. | | listActiveDeployments(...) | See the exported TypeScript signature for parameters and result. | | listDeploymentsByBotId(...) | See the exported TypeScript signature for parameters and result. | | listActiveDeploymentsByBotId(...) | See the exported TypeScript signature for parameters and result. | | listDeploymentsByFlowId(...) | See the exported TypeScript signature for parameters and result. | | listActiveDeploymentsByFlowId(...) | See the exported TypeScript signature for parameters and result. | | getDeployment(...) | See the exported TypeScript signature for parameters and result. | | deleteDeployment(...) | See the exported TypeScript signature for parameters and result. | | saveDeployment(...) | See the exported TypeScript signature for parameters and result. | | return(...) | See the exported TypeScript signature for parameters and result. | | createDeployment(...) | See the exported TypeScript signature for parameters and result. | | updateDeployment(...) | See the exported TypeScript signature for parameters and result. |

More detail

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