# menta-tickets-sdk-ts

> Para instalar el SDK, ejecuta el siguiente comando:

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

## Install

```sh
npm install menta-tickets-sdk-ts
pnpm add menta-tickets-sdk-ts
yarn add menta-tickets-sdk-ts
bun add menta-tickets-sdk-ts
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-04-03 |
| First published | 2022-12-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 18.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | mentatickets |

## Links

- npm: https://www.npmjs.com/package/menta-tickets-sdk-ts
- npm.io page: https://npm.io/package/menta-tickets-sdk-ts

## Dependencies (5)

- [jest](https://npm.io/package/jest.md) ^29.5.0
- [axios](https://npm.io/package/axios.md) ^1.3.4
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.1
- [ts-jest](https://npm.io/package/ts-jest.md) ^29.0.5
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Recent versions

- 1.0.1 (latest) — 2023-04-03
- 1.0.0 — 2022-12-29

## README

## Instalación
Para instalar el SDK, ejecuta el siguiente comando:

```http
  npm i menta-tickets-sdk-ts
```


## Uso

Para usar el SDK, importa la función "initializeMenta". Luego, podrás utilizar sus métodos para interactuar con nuestros servicios.

```http
  import { initializeMenta } from 'menta-tickets-sdk-ts';

  const config = {
    apiKey: 'Colocar mi número de api key'
  }

  const mentaTicketsSdk = initializeMenta(config);

  mentaTicketsSdk.createWallet('mi@email.com');
  mentaTicketsSdk.mintTicket('mi@email.com', { eventId: '123', ticketId: '456', ticketType: 'VIP' });
  const shouldShow = mentaTicketsSdk.shouldShowQRCode('mi@email.com', '456');
```


## Métodos

### createWallet

| Parámetro | Tipo     | Descripción                |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Requerido**. El email del usuario |


Este método crea una wallet con el email especificado.


### mintTicket

| Parámetro | Tipo     | Descripción                |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Requerido**. El email del usuario |
| `ticket` | `object` | **Requerido**. El ticket a ser minteado |


Este método crea un ticket con el email y el objeto especificados. El objeto debe incluir las propiedades eventId, ticketId y ticketType.

### shouldShowQRCode

| Parámetro | Tipo     | Descripción                |
| :-------- | :------- | :------------------------- |
| `email` | `string` | **Requerido**. El email del usuario |
| `ticketId` | `string` | **Requerido**. El ID del ticket |


Este método determina si se debe mostrar el código QR con el email y el ticketId especificados. Devuelve true si se debe mostrar y false si no.

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