# @or-sdk/tags

> OneReach SDK client for Tags

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

## Install

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

## 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.3.3 |
| Published | 2026-10-29 |
| First published | 2022-01-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 72.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | onereach.admin, user.npm |

## Links

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

## Dependencies (2)

- [@or-sdk/base](https://npm.io/package/@or-sdk/base.md) ^0.45.3
- [@or-sdk/data-hub-svc](https://npm.io/package/@or-sdk/data-hub-svc.md) ^2.5.3

## Recent versions

- 1.3.3 (latest) — 2026-10-29
- 1.3.3-beta.4425.0 (beta) — 2026-10-29
- 0.25.7-next.697.0 (next) — 2022-10-21
- 1.3.3-beta.4421.0 — 2026-10-28
- 1.3.2 — 2026-09-25
- 1.3.2-beta.4380.0 — 2026-09-25
- 1.3.1 — 2026-09-21
- 1.3.1-beta.4364.0 — 2026-09-21
- 1.3.1-beta.4362.0 — 2026-09-21
- 1.3.0 — 2026-08-05
- 1.2.1-beta.4286.0 — 2026-08-05
- 1.2.1-beta.4283.0 — 2026-08-05
- 1.2.1-beta.4282.0 — 2026-08-05
- 1.2.0 — 2026-08-05
- 1.1.10-beta.4276.0 — 2026-08-05
- … 433 more at https://npm.io/package/@or-sdk/tags/versions

## README

# `@or-sdk/tags`

OneReach SDK client for Tags.

## When to use

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

## Usage
```typescript
import { Tags } from '@or-sdk/tags'

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

// with service discovery(slower)
const tags = new Tags({
  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 |
|---|---|
| `listAllTags(...)` | See the exported TypeScript signature for parameters and result. |
| `listTags(...)` | See the exported TypeScript signature for parameters and result. |
| `getTagById(...)` | See the exported TypeScript signature for parameters and result. |
| `getMultipleTagsByName(...)` | See the exported TypeScript signature for parameters and result. |
| `getTagByName(...)` | See the exported TypeScript signature for parameters and result. |
| `saveTag(...)` | See the exported TypeScript signature for parameters and result. |
| `return(...)` | See the exported TypeScript signature for parameters and result. |
| `createTag(...)` | See the exported TypeScript signature for parameters and result. |
| `updateTag(...)` | See the exported TypeScript signature for parameters and result. |
| `deleteTag(...)` | See the exported TypeScript signature for parameters and result. |

## More detail

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

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