# sowesign-connector

> This package allows connection with the sowesign api. This is not an official package from sowesign.

Latest version **1.0.14** (published 2022-06-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install sowesign-connector
pnpm add sowesign-connector
yarn add sowesign-connector
bun add sowesign-connector
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.14 |
| Published | 2022-06-30 |
| First published | 2022-04-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 42.7 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | kouzty |

## Links

- npm: https://www.npmjs.com/package/sowesign-connector
- Repository: https://github.com/brunohanss/sowesign-connector
- Homepage: https://github.com/brunohanss/sowesign-connector#readme
- Issues: https://github.com/brunohanss/sowesign-connector/issues
- npm.io page: https://npm.io/package/sowesign-connector

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.26.1

## Recent versions

- 1.0.14 (latest) — 2022-06-30
- 1.0.13 — 2022-04-20
- 1.0.12 — 2022-04-20
- 1.0.11 — 2022-04-20
- 1.0.10 — 2022-04-20
- 1.0.9 — 2022-04-19
- 1.0.8 — 2022-04-17
- 1.0.7 — 2022-04-17
- 1.0.6 — 2022-04-17
- 1.0.5 — 2022-04-17
- 1.0.4 — 2022-04-17
- 1.0.3 — 2022-04-17
- 1.0.2 — 2022-04-17
- 1.0.1 — 2022-04-17
- 1.0.0 — 2022-04-16

## README

# SoWeSign Connector

This package allows connection with the sowesign api. This is not an official package from sowesign.

# Usage

## Init

```
import { SoWeSign } from  "sowesign-connector/lib";
export const soWeSign = await new SoWeSign().initialize(<TOKEN>, <BASE-URL>)
```

## Students

Get all()

```
await soWeSign.students.getAll(include?:
      | 'reference'
      | 'gender'
      | 'lastName'
      | 'firstName'
      | 'birthDate'
      | 'email'
      | 'mobilePhone'
      | 'phone'
      | 'adress'
      | 'opcaNumber'
      | 'regionNumber'
      | 'unemployedNumber'
      | 'fileNumber'
      | 'photo'
      | 'employer'
      | 'start'
      | 'end'
      | 'data'
      | 'thirds'
      | 'financers'[])
```

Update or create

```
await soWeSign.students.updateOrCreate(student)
```

Delete

```
await soWeSign.students.delete(reference)
```

Counters

```
await soWeSign.students.counter(from: Date | string, to: Date | string, reference: string)
```

## Thirds

Get all

```
await soWeSign.thirds.getAll(include?:
    | 'reference'
    | 'gender'
    | 'lastName'
    | 'firstName'
    | 'birthDate'
    | 'email'
    | 'mobilePhone'
    | 'phone'
    | 'adress'
    | 'opcaNumber'
    | 'regionNumber'
    | 'unemployedNumber'
    | 'fileNumber'
    | 'photo'
    | 'employer'
    | 'start'
    | 'end'
    | 'data'
    | 'thirds'
    | 'financers'[])
```

Delete

```
await soWeSign.thirds.delete(reference)
```

## Trainers

Get all

```
await soWeSign.trainers.getAll(include?:
    | 'reference'
    | 'gender'
    | 'lastName'
    | 'firstName'
    | 'birthDate'
    | 'email'
    | 'mobilePhone'
    | 'phone'
    | 'adress'
    | 'opcaNumber'
    | 'regionNumber'
    | 'unemployedNumber'
    | 'fileNumber'
    | 'photo'
    | 'employer'
    | 'start'
    | 'end'
    | 'data'
    | 'thirds'
    | 'financers'[])
```

Delete

```
await soWeSign.trainers.delete(reference)
```

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