# @or-sdk/deployer

> OneReach SDK client for Deployer

Latest version **1.9.3** (published 2026-10-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @or-sdk/deployer
pnpm add @or-sdk/deployer
yarn add @or-sdk/deployer
bun add @or-sdk/deployer
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.9.3 |
| Published | 2026-10-29 |
| First published | 2021-11-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 95 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | onereach.admin, user.npm |

## Links

- npm: https://www.npmjs.com/package/@or-sdk/deployer
- npm.io page: https://npm.io/package/@or-sdk/deployer

## Dependencies (2)

- [@or-sdk/base](https://npm.io/package/@or-sdk/base.md) ^0.45.3
- [@or-sdk/step-templates](https://npm.io/package/@or-sdk/step-templates.md) ^2.4.3

## Recent versions

- 1.9.3 (latest) — 2026-10-29
- 1.9.3-beta.4425.0 (beta) — 2026-10-29
- 0.26.4-next.697.0 (next) — 2022-10-21
- 1.9.3-beta.4421.0 — 2026-10-28
- 1.9.2 — 2026-09-25
- 1.9.2-beta.4380.0 — 2026-09-25
- 1.9.1 — 2026-09-21
- 1.9.1-beta.4364.0 — 2026-09-21
- 1.9.1-beta.4362.0 — 2026-09-21
- 1.9.0 — 2026-08-05
- 1.8.1-beta.4286.0 — 2026-08-05
- 1.8.1-beta.4283.0 — 2026-08-05
- 1.8.1-beta.4282.0 — 2026-08-05
- 1.8.0 — 2026-08-05
- 1.7.9-beta.4276.0 — 2026-08-05
- … 496 more at https://npm.io/package/@or-sdk/deployer/versions

## README

# `@or-sdk/deployer`

OneReach SDK client for Deployer.

## When to use

- Use this package when integrating with the Deployer 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/deployer
```

## Usage
```typescript
import { Deployer } from '@or-sdk/deployer'

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

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

## Configuration

- Prefer `deployerUrl` 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 |
|---|---|
| `removeRole(...)` | See the exported TypeScript signature for parameters and result. |
| `activateFlowNoPoll(...)` | See the exported TypeScript signature for parameters and result. |
| `activateFlow(...)` | See the exported TypeScript signature for parameters and result. |
| `deactivateFlowNoPoll(...)` | See the exported TypeScript signature for parameters and result. |
| `deactivateFlow(...)` | See the exported TypeScript signature for parameters and result. |
| `progressCallback(...)` | See the exported TypeScript signature for parameters and result. |
| `suspendAccount(...)` | See the exported TypeScript signature for parameters and result. |
| `resumeAccount(...)` | See the exported TypeScript signature for parameters and result. |
| `fetchFlowLogsChunk(...)` | See the exported TypeScript signature for parameters and result. |
| `fetchAllFlowLogs(...)` | 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.

### `Deployer`

| Method | Returns | Purpose |
|---|---|---|
| `pollResult({ flowId, requestId }: PollingParams, progressCallback?: (progress: PollingResultPending) => void, options?: PollingOptions)` | `Promise<T>` | Polls for activation or deactivation status, which can be 'pending' during the process |

---
_Source: https://npm.io/package/@or-sdk/deployer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
