1.3.3 • Published 3 weeks ago
@or-sdk/tags
Licence
Apache-2.0
Version
1.3.3
Deps
2
Size
72 kB
Vulns
0
Weekly
0
@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
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
dataHubSvcUrlwhen the service URL is known; it avoids a discovery request. - Use
discoveryUrlonly when the service URL is not available. - Provide
tokenas 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/.