# zegami-sdk

> Zegami SDK for developers to interact with, create, modify and remove collections and the content within.

Latest version **1.1.6** (published 2021-10-21) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install zegami-sdk
pnpm add zegami-sdk
yarn add zegami-sdk
bun add zegami-sdk
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2021-10-21 |
| First published | 2020-02-19 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 271.9 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Zegami Ltd |
| Maintainers | vaspra, tarquin_, ahaith |
| Keywords | zegami, sdk, developer, javascript, node |

## Links

- npm: https://www.npmjs.com/package/zegami-sdk
- Repository: https://github.com/zegami/zegami-js-sdk
- Homepage: https://github.com/zegami/zegami-node#readme
- Issues: https://github.com/zegami/zegami-node/issues
- npm.io page: https://npm.io/package/zegami-sdk

## Dependencies (3)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [csv-parse](https://npm.io/package/csv-parse.md) ^4.14.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.1.6 (latest) — 2021-10-21
- 1.1.5 — 2021-10-21
- 1.1.2 — 2021-07-05
- 1.0.7 — 2020-09-29
- 1.0.6 — 2020-03-10
- 1.0.5 — 2020-03-10
- 1.0.4 — 2020-02-19
- 1.0.3 — 2020-02-19
- 1.0.2 — 2020-02-19
- 1.0.1 — 2020-02-19
- 1.0.0 — 2020-02-19

## README

# zegami-js-sdk

An npm-installed node-based SDK for collection control, image downloading, file uploading, etc. using javascript.

## Installation

Install this package in your node project using `npm install --save zegami-sdk`

## Usage

Create a ZegamiClient instance using your username and password or a previously generated auth token. This will authenticate any requests made through it using a stored token.

```javascript
const createClient = require('zegami-sdk');

const zClient = await createClient({
        username,
        password,
        token,
    });
```

Further actions are carried out through this client. For example - to obtain your user information, try:

```javascript
const printUserInfo = async () => {
    let info = await zClient.userInfo;
    console.log(`userInfo:`, info);
}
```

## Early Development

Please check back later for more features.

## Development Tips

## npm link

Clone this SDK and navigate to the directory, and enter `npm link`. Then, navigate to the application being worked on alongside the SDK
and enter `npm link zegami-sdk`. Any changes made to the cloned repository will be instantly reflected in the application during development.

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