# @digigov-oss/sms-sender-service-client

> Client for SmsSenderService of KED

Latest version **1.0.1** (published 2023-12-12) · 0 weekly downloads

## Install

```sh
npm install @digigov-oss/sms-sender-service-client
pnpm add @digigov-oss/sms-sender-service-client
yarn add @digigov-oss/sms-sender-service-client
bun add @digigov-oss/sms-sender-service-client
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-12-12 |
| First published | 2023-02-23 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.13.1 |
| Dependencies | 3 |
| Unpacked size | 46.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dimitrios Michail |
| Maintainers | dmassaad-grnet, dmichail, pskarvelis |
| Keywords | gsis, ked, sms, SmsSenderService |

## Links

- npm: https://www.npmjs.com/package/@digigov-oss/sms-sender-service-client
- Repository: https://gitlab.grnet.gr/digigov-oss/smsSenderServiceClient
- Homepage: https://gitlab.grnet.gr/digigov-oss/smsSenderServiceClient/-/blob/main/README.md
- Issues: https://gitlab.grnet.gr/digigov-oss/smsSenderServiceClient/-/issues
- npm.io page: https://npm.io/package/@digigov-oss/sms-sender-service-client

## Dependencies (3)

- [soap](https://npm.io/package/soap.md) ^0.45.0
- [axios](https://npm.io/package/axios.md) ^1.6.2
- [@digigov-oss/gsis-audit-record-db](https://npm.io/package/@digigov-oss/gsis-audit-record-db.md) ^1.2.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-12-12
- 1.0.0 — 2023-02-23

## README

# Client for Sms sender service of KED

Client to connect to the SMS sender service, useful for nextjs/nodejs projects.

#### Example:

```
import sendSMSToMobile from '@digigov-oss/sms-sender-service-client';

const test = async () => {
   const overrides = {
        prod:false,
        auditInit: {
            auditUnit: 'grnet.gr',
        },
        auditStoragePath: '/auditStorage',
    }

    try {
        const result = await sendSMSToMobile("accountAfm", "mobile", "message", "username", "password",overrides);
        return result;
    } catch (error) {
        console.log(error);
    }
}

test().then((x) => { console.log('response', x); });
```

-   you can use `overrides` to override the default values
-   for your tests, you don't need to use the `overrides` mecahnism,in that case, the default storage path will be used ie `/tmp`
-   look at [KED](https://www.gsis.gr/dimosia-dioikisi/ked/) standard guides for records you can use on auditInit"
    Also, you can use `overrides` to override the default storage engine.

```
import sendSMSToMobile from '@digigov-oss/get-nnc-identity-Ext-client';
import {PostgreSqlEngine} from '@digigov-oss/gsis-audit-record-db';

const test = async () => {
    try {
        const overrides = {
        auditEngine: new PostgreSqlEngine('postgres://postgres:postgres@localhost:5432/postgres'),
        auditInit: {
            auditUnit: 'grnet.gr',
        },
        }
        const result = await sendSMSToMobile("accountAfm", "mobile", "message", "username", "password",overrides);
        return result;
    } catch (error) {
        console.log(error);
    }
}

test().then((x) => { console.log('response', x); });

```

Look at module [AuditRecordDB](https://gitlab.grnet.gr/digigov-oss/auditRecordDB/-/blob/main/README.md) for more details on how to use the AuditEngine.

If you plan to use only the `FileEngine`, you can skip the installation of other engines by ignoring optional dependencies.
i.e.` yarn install --ignore-optional`

#### Returns

an object like the following:

```
{
    status: '1',
    message: 'Δοκιμαστικό μήνυμα", 
    credits: '85'
}
```

or an error message like:

```
{ message: 'Ο Α.Φ.Μ. δεν είναι καταχωρημένος' }
```

#### Available Mobile Numbers for testing:

0000000000

##### \* Notes

you have to ask KED for smsSenderService_KED_v_0.91 documentation to get more info about the output and error fields.

#### \* known issues

If the endpoint is not correct, you can override it by setting the `endpoint` property on the `overrides` object.

```
const overrides = {
    endpoint: 'https://ked.gsis.gr/esb/...',
}
```

---
_Source: https://npm.io/package/@digigov-oss/sms-sender-service-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._